Get messages by conversation id - HoopAI Help Center

GET

conversations

{conversationId}

messages

Get messages by conversation id

curl --request GET \
  --url https://services.leadconnectorhq.com/conversations/{conversationId}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'

const options = {
  method: 'GET',
  headers: {Version: '<version>', Authorization: 'Bearer <token>'}
};

fetch('https://services.leadconnectorhq.com/conversations/{conversationId}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/conversations/{conversationId}/messages"

headers = {
    "Version": "<version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "messages": {
    "lastMessageId": "p1mRSHeLDhAms5q0LMr4",
    "nextPage": true,
    "messages": [
      {
        "id": "ve9EPM428h8vShlRW1KT",
        "type": 1,
        "messageType": "SMS",
        "locationId": "ve9EPM428h8vShlRW1KT",
        "contactId": "ve9EPM428h8vShlRW1KT",
        "conversationId": "ve9EPM428h8vShlRW1KT",
        "dateAdded": "2024-03-27T18:13:49.000Z",
        "contentType": "text/plain",
        "altId": "msg_123456789",
        "body": "Hi there",
        "attachments": [
          "<string>"
        ],
        "meta": {
          "callDuration": 120,
          "callStatus": "completed",
          "email": {
            "email": {
              "messageIds": [
                "ve9EPM428kjkvShlRW1KT",
                "ve9EPs1028kjkvShlRW1KT"
              ]
            }
          }
        },
        "userId": "ve9EPM428kjkvShlRW1KT",
        "conversationProviderId": "ve9EPM428kjkvShlRW1KT",
        "chatWidgetId": "67b0cc8cf14b19d85ace7s35"
      }
    ]
  }
}

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

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

Authorizations

Authorization

string

header

required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

Version

enum<string>

required

API Version

Available options:

2021-04-15

Path Parameters

conversationId

string

required

Conversation ID as string

Example:

"tDtDnQdgm2LXpyiqYvZ6"

Query Parameters

lastMessageId

string

Message ID of the last message in the list as a string

Example:

"tDtDnQdgm2LXpyiqYvZ6"

limit

number

Number of messages to be fetched from the conversation. Default limit is 20

Example:

20

type

enum<string>

Types of message to fetched separated with comma

Available options:

TYPE_CALL,

TYPE_SMS,

TYPE_EMAIL,

TYPE_FACEBOOK,

TYPE_GMB,

TYPE_INSTAGRAM,

TYPE_WHATSAPP,

TYPE_ACTIVITY_APPOINTMENT,

TYPE_ACTIVITY_CONTACT,

TYPE_ACTIVITY_INVOICE,

TYPE_ACTIVITY_PAYMENT,

TYPE_ACTIVITY_OPPORTUNITY,

TYPE_LIVE_CHAT,

TYPE_INTERNAL_COMMENTS,

TYPE_ACTIVITY_EMPLOYEE_ACTION_LOG

Example:

"TYPE_SMS,TYPE_CALL"

Response

List of messages for the conversation id of the given type.

messages

object

required

Show child attributes

Last modified on March 8, 2026

Upload file attachments

Get message by message id

Get messages by conversation id

curl --request GET \
  --url https://services.leadconnectorhq.com/conversations/{conversationId}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'

const options = {
  method: 'GET',
  headers: {Version: '<version>', Authorization: 'Bearer <token>'}
};

fetch('https://services.leadconnectorhq.com/conversations/{conversationId}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/conversations/{conversationId}/messages"

headers = {
    "Version": "<version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "messages": {
    "lastMessageId": "p1mRSHeLDhAms5q0LMr4",
    "nextPage": true,
    "messages": [
      {
        "id": "ve9EPM428h8vShlRW1KT",
        "type": 1,
        "messageType": "SMS",
        "locationId": "ve9EPM428h8vShlRW1KT",
        "contactId": "ve9EPM428h8vShlRW1KT",
        "conversationId": "ve9EPM428h8vShlRW1KT",
        "dateAdded": "2024-03-27T18:13:49.000Z",
        "contentType": "text/plain",
        "altId": "msg_123456789",
        "body": "Hi there",
        "attachments": [
          "<string>"
        ],
        "meta": {
          "callDuration": 120,
          "callStatus": "completed",
          "email": {
            "email": {
              "messageIds": [
                "ve9EPM428kjkvShlRW1KT",
                "ve9EPs1028kjkvShlRW1KT"
              ]
            }
          }
        },
        "userId": "ve9EPM428kjkvShlRW1KT",
        "conversationProviderId": "ve9EPM428kjkvShlRW1KT",
        "chatWidgetId": "67b0cc8cf14b19d85ace7s35"
      }
    ]
  }
}

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

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