Skip to main content
GET
/
api
/
v1
/
conversations
List Conversations
curl --request GET \
  --url https://api.example.com/api/v1/conversations \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "user_id": "<string>",
      "store_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "item_count": 0
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
user_id
string | null
​
limit
integer
default:20
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

​
items
ConversationListItem · object[]
required

List of conversations matching the filter

​
total
integer
required

Total number of conversations matching the filter

​
limit
integer
required

Maximum number of items returned

​
offset
integer
required

Number of items skipped (for pagination)