Skip to main content

List all conversations

Returns a list of your conversations. The conversations are returned sorted by creation date, with the most recently created conversations appearing first.

Parameters

state
enum
The state of conversations to return. The default is active. One of all, active, archived.

Returns

Return a paginated response that contains an array of up to the specified limit of conversations.

get
/api/conversations
curl https://{workspace}.kitchen.co/api/conversations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Requested-With: XMLHttpRequest' \
-H 'Authorization: Bearer {API_KEY}'
Response
{
"data": [
{
"archived_at": null,
"created_at": "2024-03-07T07:47:02+00:00",
"id": "convr_1lbg89ha9ttb5dmxuldku3nx",
"latest_message_created_at": null,
"latest_message": null,
"messages_count": 0,
"status": "open",
"title": "New Conversation",
"updated_at": "2024-03-07T07:47:02+00:00",
"visibility": "shared"
}
],
"links": {
"first": "/api/conversations?page=1",
"last": "/api/conversations?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "/api/conversations?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "/api/conversations",
"per_page": 20,
"to": 1,
"total": 1
}
}