Get messages for a specific conversation.

GET

https://host.com/v1/conversations/:conversationId/messages

X-API-Keystring

API Key authentication. Generate your API key in the Gail Portal under General > Integrations > API Keys.

conversationIdstringRequiredformat: "uuid"

The unique identifier of the conversation.

includeArchivedbooleanOptionalDefaults to false

When true, allows retrieving messages from archived conversations.

afterstringOptionalformat: "uuid"

A GUID cursor to fetch items strictly after this ID.

beforestringOptionalformat: "uuid"

A GUID cursor to fetch items strictly before this ID.

limitintegerOptionalDefaults to 50

Maximum number of items to retrieve (default 50).

pageintegerOptionalDefaults to 1Deprecated

The page number (1-based).

sizeintegerOptionalDefaults to 50Deprecated

Number of items per page (default 50).

datalist of objects or nullOptional

totalinteger or nullOptional

pageinteger or nullOptional

sizeinteger or nullOptional

pagesinteger or nullOptional

400

Bad Request Error

404

Not Found Error

1	const url = 'https://host.com/v1/conversations/conversationId/messages';
2	const options = {method: 'GET', headers: {'X-API-Key': '<apiKey>'}};
3
4	try {
5	const response = await fetch(url, options);
6	const data = await response.json();
7	console.log(data);
8	} catch (error) {
9	console.error(error);
10	}