# Export messages by location ID

- **URL:** https://marketplace.gohighlevel.com/docs/ghl/conversations/export-messages-by-location
- **Summary:** Export messages for a specific location with cursor-based pagination support.

[Skip to main content](https://marketplace.gohighlevel.com/docs/ghl/conversations/export-messages-by-location#__docusaurus_skipToContent_fallback)

Version: v3

Export messages by location ID
==============================

GET 

https://services.leadconnectorhq.com/conversations/messages/export

Copy for LLMView as MarkdownOpen in ClaudeOpen in ChatGPTOpen in Cursor

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.

### Requirements

#### Scope(s)

`conversations/message.readonly`

#### Auth Method(s)

`OAuth Access Token``Private Integration Token`

#### Token Type(s)

`Sub-Account Token`

Request[​](https://marketplace.gohighlevel.com/docs/ghl/conversations/export-messages-by-location#request "Direct link to request")

### Header Parameters

**Version** stringrequired

**Possible values:** \[`v3`\]

API Version

### Query Parameters

**locationId** stringrequired

Location ID to filter messages by

**channel** string

**Possible values:** \[`Call`, `SMS`, `Email`, `WhatsApp`, `Instagram`, `Facebook`\]

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.

**limit** number

**Possible values:** `>= 10` and `<= 1000`

Number of messages to return per page

Default value:`100`

**cursor** string

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

**Example:** `a748514c-f49e-4fa8-9954-b53afc78d81d`

**sortBy** string

**Possible values:** \[`createdAt`, `updatedAt`\]

Field to sort by

Default value:`createdAt`

**sortOrder** string

**Possible values:** \[`asc`, `desc`\]

Sort order

Default value:`desc`

**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

Responses[​](https://marketplace.gohighlevel.com/docs/ghl/conversations/export-messages-by-location#responses "Direct link to Responses")

*   200
*   400
*   401

List of messages for the location with pagination details.

*   application/json

*   Schema
*   Example (auto)

**Schema**

**messages** object\[\]required

Array of messages

*   Array \[\
    \
\
**id**stringrequired\
\
**Example:** `ve9EPM428h8vShlRW1KT`\
\
**altId**string\
\
Alternative identifier for the message\
\
**Example:** `msg_123456789`\
\
**type**numberrequired\
\
**Example:** `1`\
\
**messageType**stringrequired\
\
Type of the message as a string\
\
**Possible values:** \[`TYPE_CALL`, `TYPE_SMS`, `TYPE_EMAIL`, `TYPE_SMS_REVIEW_REQUEST`, `TYPE_WEBCHAT`, `TYPE_SMS_NO_SHOW_REQUEST`, `TYPE_CAMPAIGN_SMS`, `TYPE_CAMPAIGN_CALL`, `TYPE_CAMPAIGN_EMAIL`, `TYPE_CAMPAIGN_VOICEMAIL`, `TYPE_FACEBOOK`, `TYPE_CAMPAIGN_FACEBOOK`, `TYPE_CAMPAIGN_MANUAL_CALL`, `TYPE_CAMPAIGN_MANUAL_SMS`, `TYPE_GMB`, `TYPE_CAMPAIGN_GMB`, `TYPE_REVIEW`, `TYPE_INSTAGRAM`, `TYPE_WHATSAPP`, `TYPE_CUSTOM_SMS`, `TYPE_CUSTOM_EMAIL`, `TYPE_CUSTOM_PROVIDER_SMS`, `TYPE_CUSTOM_PROVIDER_EMAIL`, `TYPE_IVR_CALL`, `TYPE_ACTIVITY_CONTACT`, `TYPE_ACTIVITY_INVOICE`, `TYPE_ACTIVITY_PAYMENT`, `TYPE_ACTIVITY_OPPORTUNITY`, `TYPE_LIVE_CHAT`, `TYPE_LIVE_CHAT_INFO_MESSAGE`, `TYPE_ACTIVITY_APPOINTMENT`, `TYPE_FACEBOOK_COMMENT`, `TYPE_INSTAGRAM_COMMENT`, `TYPE_CUSTOM_CALL`, `TYPE_INTERNAL_COMMENT`, `TYPE_ACTIVITY_EMPLOYEE_ACTION_LOG`\]\
\
**Example:** `SMS`\
\
**locationId**stringrequired\
\
**Example:** `ve9EPM428h8vShlRW1KT`\
\
**contactId**stringrequired\
\
**Example:** `ve9EPM428h8vShlRW1KT`\
\
**conversationId**stringrequired\
\
**Example:** `ve9EPM428h8vShlRW1KT`\
\
**dateAdded**stringrequired\
\
**Example:** `2024-03-27T18:13:49.000Z`\
\
**body**string\
\
**Example:** `Hi there`\
\
**direction**stringrequired\
\
**Possible values:** \[`inbound`, `outbound`\]\
\
**status**string\
\
**Possible values:** \[`connected`, `delivered`, `failed`, `opened`, `pending`, `read`, `scheduled`, `sent`, `undelivered`, `clicked`, `opt_out`\]\
\
**contentType**stringrequired\
\
**Example:** `text/plain`\
\
**attachments**string\[\]\
\
An array of attachment URLs. Attachments will be empty for Call and Voicemails, type 1 and 10. Please use get call recording API to fetch call recording and voicemails.\
\
**meta** object\
\
**callDuration**string\
\
Call duration in seconds\
\
**Example:** `120`\
\
**callStatus**string\
\
Call status - can be pending, completed, answered, busy, no-answer, failed, canceled, or voicemail\
\
**Possible values:** \[`pending`, `completed`, `answered`, `busy`, `no-answer`, `failed`, `canceled`, `voicemail`\]\
\
**Example:** `completed`\
\
**email**object\
\
meta will contain email, for message type 3 (email). messageIds is list of all email message ids under the message thread\
\
**Example:** `{"email":{"messageIds":["ve9EPM428kjkvShlRW1KT","ve9EPs1028kjkvShlRW1KT"]}}`\
\
**ig**object\
\
meta will contain ig, for message type 18 (instagram).\
\
**Example:** `{"ig":{"page_id":"1234567890","page_name":"Instagram Page"}}`\
\
**fb**object\
\
meta will contain fb, for message type 11 (facebook).\
\
**Example:** `{"fb":{"page_id":"1234567890","page_name":"Facebook Page"}}`\
\
**source**string\
\
Message source\
\
**Possible values:** \[`workflow`, `bulk_actions`, `campaign`, `api`, `app`\]\
\
**userId**string\
\
User Id\
\
**Example:** `ve9EPM428kjkvShlRW1KT`\
\
**conversationProviderId**string\
\
Conversation Provider Id\
\
**Example:** `ve9EPM428kjkvShlRW1KT`\
\
**chatWidgetId**string\
\
Chat Widget Id\
\
**Example:** `67b0cc8cf14b19d85ace7s35`\
\
**from**string\
\
Sender identifier (phone/name). Not returned for email types.\
\
**Example:** `+14155551234`\
\
**to**string\
\
Recipient identifier (phone/name). Not returned for email types.\
\
**Example:** `+14155555678`\
\
**error**string\
\
Error message if message delivery failed\
\
*   \]
    

**nextCursor**string

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

**Example:** `a748514c-f49e-4fa8-9954-b53afc78d81d`

**total**numberrequired

Total number of messages matching the query

**Example:** `1234`

    {  "messages": [    {      "id": "ve9EPM428h8vShlRW1KT",      "altId": "msg_123456789",      "type": 1,      "messageType": "SMS",      "locationId": "ve9EPM428h8vShlRW1KT",      "contactId": "ve9EPM428h8vShlRW1KT",      "conversationId": "ve9EPM428h8vShlRW1KT",      "dateAdded": "2024-03-27T18:13:49.000Z",      "body": "Hi there",      "direction": "inbound",      "status": "connected",      "contentType": "text/plain",      "attachments": [        "string"      ],      "meta": {        "callDuration": 120,        "callStatus": "completed",        "email": {          "email": {            "messageIds": [              "ve9EPM428kjkvShlRW1KT",              "ve9EPs1028kjkvShlRW1KT"            ]          }        },        "ig": {          "ig": {            "page_id": "1234567890",            "page_name": "Instagram Page"          }        },        "fb": {          "fb": {            "page_id": "1234567890",            "page_name": "Facebook Page"          }        }      },      "source": "workflow",      "userId": "ve9EPM428kjkvShlRW1KT",      "conversationProviderId": "ve9EPM428kjkvShlRW1KT",      "chatWidgetId": "67b0cc8cf14b19d85ace7s35",      "from": "+14155551234",      "to": "+14155555678",      "error": "string"    }  ],  "nextCursor": "a748514c-f49e-4fa8-9954-b53afc78d81d",  "total": 1234}

Bad Request

*   application/json

*   Schema
*   Example (auto)

**Schema**

**statusCode**number

**Example:** `400`

**message**string

**Example:** `Bad Request`

    {  "statusCode": 400,  "message": "Bad Request"}

Unauthorized

*   application/json

*   Schema
*   Example (auto)

**Schema**

**statusCode**number

**Example:** `401`

**message**string

**Example:** `Invalid token: access token is invalid`

**error**string

**Example:** `Unauthorized`

    {  "statusCode": 401,  "message": "Invalid token: access token is invalid",  "error": "Unauthorized"}

Share your feedback
-------------------

★★★★★

#### Authorization: Authorization

**name:** [Authorization](https://marketplace.gohighlevel.com/docs/ghl/conversations/conversations-api#authentication)
**type:** http**scopes:** `conversations/message.readonly`**scheme:** bearer**bearerFormat:** JWT**in:** header**description:** Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

*   curl
*   nodejs
*   python
*   php
*   java
*   go
*   ruby
*   powershell

*   CURL

    curl -L 'https://services.leadconnectorhq.com/conversations/messages/export?limit=100&cursor=a748514c-f49e-4fa8-9954-b53afc78d81d&sortBy=createdAt&sortOrder=desc' \-H 'Accept: application/json' \-H 'Authorization: Bearer <Authorization>'

RequestCollapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

locationId — queryrequired

Version — headerrequired\---v3

Show optional parameters

channel — query\---CallSMSEmailWhatsAppInstagramFacebook

limit — query

cursor — query

sortBy — query\---createdAtupdatedAt

sortOrder — query\---ascdesc

conversationId — query

contactId — query

startDate — query

endDate — query

Send API Request

ResponseClear

Click the `Send API Request` button above and see the response here!