GET
/
public
/
messages
curl --request GET \
  --url https://web-api.clerk.chat/public/messages \
  --header 'apiKey: <api-key>'
{
  "data": [
    {
      "id": 1,
      "body": "Hello, world!",
      "conversationId": "1",
      "userId": "1",
      "campaignMessageId": 1,
      "campaignId": 1,
      "channelId": "00000000-0000-0000-0000-000000000000",
      "inboxId": "00000000-0000-0000-0000-000000000000",
      "inbound": true,
      "members": [
        "+1415456789"
      ],
      "sender": "+1415456789",
      "senderType": "user",
      "status": "delivered",
      "error": "<string>",
      "sentByName": "Clerk",
      "errorCode": 123,
      "created": "2021-01-01T00:00:00.000Z",
      "updated": "2021-01-01T00:00:00.000Z",
      "seen": true,
      "externalId": "external-id",
      "segments": 1,
      "timestamp": "2021-01-01T00:00:00.000Z"
    }
  ],
  "links": {
    "next": "<string>",
    "prev": "<string>",
    "self": "<string>"
  },
  "total": 1
}

Authorizations

​
apiKey
string
header
required

Query Parameters

​
inboxIds
string[]

The IDs of the inboxes to filter messages by. If not provided, all inboxes will be included.

​
start
string

Only messages after this date until the end date or now

​
end
string

Only messages up to this date

​
limit
number

Number of items to return (max 50)

​
page
number

Page number

Response

200
application/json

A paginated list of messages

The response is of type object.

GET
/
public
/
messages
curl --request GET \
  --url https://web-api.clerk.chat/public/messages \
  --header 'apiKey: <api-key>'
{
  "data": [
    {
      "id": 1,
      "body": "Hello, world!",
      "conversationId": "1",
      "userId": "1",
      "campaignMessageId": 1,
      "campaignId": 1,
      "channelId": "00000000-0000-0000-0000-000000000000",
      "inboxId": "00000000-0000-0000-0000-000000000000",
      "inbound": true,
      "members": [
        "+1415456789"
      ],
      "sender": "+1415456789",
      "senderType": "user",
      "status": "delivered",
      "error": "<string>",
      "sentByName": "Clerk",
      "errorCode": 123,
      "created": "2021-01-01T00:00:00.000Z",
      "updated": "2021-01-01T00:00:00.000Z",
      "seen": true,
      "externalId": "external-id",
      "segments": 1,
      "timestamp": "2021-01-01T00:00:00.000Z"
    }
  ],
  "links": {
    "next": "<string>",
    "prev": "<string>",
    "self": "<string>"
  },
  "total": 1
}

Authorizations

​
apiKey
string
header
required

Query Parameters

​
inboxIds
string[]

The IDs of the inboxes to filter messages by. If not provided, all inboxes will be included.

​
start
string

Only messages after this date until the end date or now

​
end
string

Only messages up to this date

​
limit
number

Number of items to return (max 50)

​
page
number

Page number

Response

200
application/json

A paginated list of messages

The response is of type object.