Skip to main content
Version: v3

Export messages by location ID

GET 
/conversations/messages/export

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.
  • Cursor validity is 2 minutes from the last request made.

Request​

Version stringrequired

API Version

Available optionsv3
locationId stringrequired

Location ID to filter messages by

channel string

Filter by message channel. Optional - when not provided, all non-email message types will be returned including activity messages (opportunity updates, appointments, etc.). To fetch email messages, you must explicitly set channel=Email.

Available optionsCallSMSEmailWhatsAppInstagramFacebook
limit number

Number of messages to return per page

Possible values: >= 10 and <= 1000

Default value:100
cursor string

Cursor for pagination. Pass the nextCursor from previous response to get next page.

sortBy string

Field to sort by

Available optionscreatedAtupdatedAt
sortOrder string

Sort order

Available optionsascdesc
conversationId string

Filter messages by conversation ID

contactId string

Filter messages by contact ID

startDate string

Start date to filter messages by

endDate string

End date to filter messages by

application/json

List of messages for the location with pagination details.

Schema
    messagesobject[]required

    Array of messages

    nextCursorstring

    Cursor for fetching next page. Null if no more results.

    totalnumberrequired

    Total number of messages matching the query