curl --request GET \
--url https://api.botpress.cloud/v1/chat/conversations \
--header 'Authorization: Bearer <token>' \
--header 'x-bot-id: <x-bot-id>'{
"conversations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"channel": "<string>",
"integration": "<string>",
"tags": {},
"currentTaskId": "<string>",
"currentWorkflowId": "<string>"
}
],
"meta": {
"nextToken": "<string>"
}
}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.
curl --request GET \
--url https://api.botpress.cloud/v1/chat/conversations \
--header 'Authorization: Bearer <token>' \
--header 'x-bot-id: <x-bot-id>'{
"conversations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"channel": "<string>",
"integration": "<string>",
"tags": {},
"currentTaskId": "<string>",
"currentWorkflowId": "<string>"
}
],
"meta": {
"nextToken": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bot id
Integration id
Integration alias
Provide the meta.nextToken value provided in the last API response to retrieve the next page of results
Sort results by this field
createdAt, updatedAt Sort results in this direction
asc, desc Filter by tags
Show child attributes
Filter by participant ids
Filter by integration name
Filter by integration channel name
Returns a list of Conversation objects
Was this page helpful?