ghl_conversation_export_messages_by_location
Read-onlyIdempotent
Export messages from a specific location with cursor-based pagination. Filter by channel, date range, conversation, or contact to retrieve targeted message history.
Instructions
Export messages by location ID Export messages for a specific location with cursor-based pagination support. Response includes messageType (string), source, and subType fields. The channel parameter is optional - if not provided, all non-email message types will be returned including activity messages (opportunity updates, appointments, etc.). Endpoint: GET /conversations/messages/export (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.readonly Pagination params: limit, cursor — pass them to page through full result sets.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of messages to return per page | |
| cursor | No | Cursor for pagination. Pass the nextCursor from previous response to get next page. | |
| sortBy | No | Field to sort by | createdAt |
| channel | No | 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. | |
| endDate | No | End date to filter messages by | |
| contactId | No | Filter messages by contact ID | |
| sortOrder | No | Sort order | desc |
| startDate | No | Start date to filter messages by | |
| locationId | Yes | Location ID to filter messages by | |
| conversationId | No | Filter messages by conversation ID |