Docs

listConversations

Retrieves a list of 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.

GET/v1/chat/conversations

Authorization

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

Header parameters

x-bot-idstringrequired
Bot id
x-integration-idstring
Integration id
x-integration-aliasstring
Integration alias

Query parameters

nextTokenstring
Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
sortFieldenum<string>
Sort results by this field
Available options:"createdAt","updatedAt"
sortDirectionenum<string>
Sort results in this direction
Available options:"asc","desc"
tagsobject
Filter by tags
participantIdsstring[]
Filter by participant ids
integrationNamestring
Filter by integration name
channelstring
Filter by integration channel name
afterDatestring
Date in ISO 8601 string with UTC timezone after which the conversation was created (inclusive)
beforeDatestring
Date in ISO 8601 string with UTC timezone before which the conversation was created (inclusive)

Response

Returns a list of Conversation objects

conversationsobject[]required
metaobjectrequired