Skip to main content
GET
/
api
/
v1
/
businesses
/
{businessId}
/
conversations
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "starred": true,
      "replyMode": "AUTO",
      "agentDisabled": true,
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lastMessageAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key prefixed with sk-ak-. Pass as Authorization: Bearer sk-ak-...

Path Parameters

​
businessId
string<uuid>
required

The business ID

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
​
contactId
string<uuid>

Filter by contact

​
starred
enum<string>

Filter starred conversations

Available options:
true,
false
​
replyMode
enum<string>
Available options:
AUTO,
MANUAL
​
sort
enum<string>
default:-lastMessageAt
Available options:
lastMessageAt,
-lastMessageAt,
createdAt,
-createdAt

Response

Paginated list of conversations

​
data
object[]
​
pagination
object