List Conversations
Retrieves a list of [Conversation](#schema_conversation) you’ve previously created. The conversations are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
Query Parameters
Provide the meta.nextToken value provided in the last API response to retrieve the next page of results
Number of items to return per page (default 20, max 100)
Sort results by this field
Value in
- "createdAt"
- "updatedAt"
Sort results in this direction
Value in
- "asc"
- "desc"
Filter by participant ids
Filter by integration name
Filter by integration channel name
Date in ISO 8601 string with UTC timezone after which the conversation was created (inclusive)
Date in ISO 8601 string with UTC timezone before which the conversation was created (inclusive)
Filter conversations with a message count greater than or equal to this value (inclusive)
Filter conversations with a message count less than or equal to this value (inclusive)
Header Parameters
Bot id
Integration id
Integration alias
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/chat/conversations" \ -H "x-bot-id: string"{ "conversations": [ { "id": "stringstringstringstringstri", "currentTaskId": "stringstringstringstringstri", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "channel": "string", "integration": "string", "tags": { "property1": "string", "property2": "string" }, "messageCount": 0, "properties": { "property1": "string", "property2": "string" } } ], "meta": { "nextToken": "string" }}{ "conversations": [ { "id": "stringstringstringstringstri", "currentTaskId": "stringstringstringstringstri", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "channel": "string", "integration": "string", "tags": { "property1": "string", "property2": "string" }, "messageCount": 0, "properties": { "property1": "string", "property2": "string" } } ], "meta": { "nextToken": "string" }}