Chat Messages
Get metadata on all Chat Messages
Paginate through all chat messages in Affinity. Returns basic information about the chat message interaction and its participants. Will only return chat messages that the current authenticated user has permission to see.
You can filter chat messages using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties.
| Property Name | Type | Allowed Operators | Examples |
|---|---|---|---|
| id | int64 | = | id=1|id=2|id=3 |
| sentAt | datetime | >, <, >=, <= | sentAt>2025-01-01T01:00:00Z |
| createdAt | datetime | >, <, >=, <= | createdAt<2025-01-01T01:00:00Z |
| updatedAt | datetime | >, <, >=, <= | updatedAt>=2025-01-01T01:00:00Z |
get/v2/chat-messages
Query parameters
cursorstring
Example:ICAgICAgYmVmb3JlOjo6Nw
Cursor for the next or previous page
limitinteger
Example:100
Number of items to include in the page
filterstring
Filter options
Response
OK
Example response
{
"data": [
{
"id": 1,
"sentAt": "2023-01-01T00:00:00Z",
"loggingType": "manual",
"direction": "sent",
"creator": {
"id": 1,
"firstName": "Jane",
"lastName": "Doe",
"primaryEmailAddress": "jane.smith@northpointvc.com",
"type": "internal"
},
"createdAt": "2022-01-01T00:00:00Z",
"updatedAt": "2023-01-01T00:00:00Z",
"participantsPreview": {
"data": [
{
"id": 1,
"firstName": "Jane",
"lastName": "Doe",
"primaryEmailAddress": "jane.smith@northpointvc.com",
"type": "internal"
}
],
"totalCount": 200
}
}
],
"pagination": {
"prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}
}