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

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

Header parameters

x-bp-authenticated-principalstring
Authenticated principal. Injected by the authentication middleware.
x-bot-idstring
Bot id
x-integration-id?string
Integration id
x-integration-alias?string
Integration alias

Query parameters

nextToken?string
Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
pageSize?integer
Number of items to return per page (default 20, max 100)
sortField?enum<string>
Sort results by this field
Available options:"createdAt","updatedAt"
sortDirection?enum<string>
Sort results in this direction
Available options:"asc","desc"
tags?object
Filter by tags
participantIds?string[]
Filter by participant ids
integrationName?string
Filter by integration name
channel?string
Filter by integration channel name
afterDate?string
Date in ISO 8601 string with UTC timezone after which the conversation was created (inclusive)
beforeDate?string
Date in ISO 8601 string with UTC timezone before which the conversation was created (inclusive)
minMessageCount?integer
Filter conversations with a message count greater than or equal to this value (inclusive)
maxMessageCount?integer
Filter conversations with a message count less than or equal to this value (inclusive)

Response

Returns a list of Conversation objects

conversationsobject[]
metaobject