API ReferenceConversations

Get a specific conversation by ID.

View as Markdown

Authentication

X-API-Keystring

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

Path parameters

conversationIdstringRequiredformat: "uuid"
The unique identifier of the conversation.

Query parameters

includeArchivedbooleanOptionalDefaults to false
When true, allows retrieving archived conversations.

Response

OK
ConversationChatobject
OR
ConversationSmsobject
OR
ConversationGptobject
OR
ConversationWhatsAppobject

Errors