Skip to main content
GET
/
v2
/
chat-messages
Get metadata on all Chat Messages
curl --request GET \
  --url https://api.affinity.co/v2/chat-messages \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 4503599627370496,
      "sentAt": "2023-11-07T05:31:56Z",
      "loggingType": "<string>",
      "direction": "sent",
      "creator": {
        "id": 4503599627370496,
        "firstName": "<string>",
        "lastName": "<string>",
        "primaryEmailAddress": "[email protected]",
        "type": "internal"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "participantsPreview": {
        "data": [
          {
            "id": 4503599627370496,
            "firstName": "<string>",
            "lastName": "<string>",
            "primaryEmailAddress": "[email protected]",
            "type": "internal"
          }
        ],
        "totalCount": 4503599627370495
      }
    }
  ],
  "pagination": {
    "prevUrl": "<string>",
    "nextUrl": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
cursor
string

Cursor for the next or previous page

Example:

"ICAgICAgYmVmb3JlOjo6Nw"

​
limit
integer<int32>
default:100

Number of items to include in the page

Required range: 1 <= x <= 100
Example:

100

​
filter
string

Filter options

Response

OK

ChatMessagePaged model

​
data
interactions.ChatMessage · object[]
required

A page of ChatMessage results

Maximum array length: 100
​
pagination
Pagination · object
required
Example:
{
  "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
  "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}