Export messages by location ID
Export messages for a specific location with cursor-based pagination support.
Channel Filtering Behavior:
- When channel is omitted: Returns all non-email message types, including messages that don't belong to any specific channel.
- When channel=Email: Returns email messages only.
- When channel is specified (SMS, Call, WhatsApp, etc.): Returns messages for that specific channel.
Limitations:
- Group Chat and SMS Review Request message types are not supported.
- Activity messages (opportunity updates, appointments, etc.) are not included in the export. Use
GET /conversations/{conversationId}/messages(Get messages by conversation id) to fetch them. - Cursor validity is 2 minutes from the last request made.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
conversations/ message. readonlyOAuthPrivate IntegrationSub-Account TokenRequest
Headers
API Version
v3Query Parameters
Location ID to filter messages by
Filter by message channel. Optional - when not provided, all non-email message types will be returned, except activity messages (opportunity updates, appointments, etc.), which are not included in the export. To fetch email messages, you must explicitly set channel=Email.
CallSMSEmailWhatsAppInstagramFacebookNumber of messages to return per page
Possible values: >= 10 and <= 1000
100Cursor for pagination. Pass the nextCursor from previous response to get next page.
a748514c-f49e-4fa8-9954-b53afc78d81dField to sort by
createdAtupdatedAtSort order
ascdescFilter messages by conversation ID
Filter messages by contact ID
Start date to filter messages by
End date to filter messages by
Response
List of messages for the location with pagination details.
Array of messages
Cursor for fetching next page. Null if no more results.
a748514c-f49e-4fa8-9954-b53afc78d81dTotal number of messages matching the query
1234