Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Messages

List conversations

This endpoint lets you list all the Conversations you have access to.

You can filter the conversations based on the Organization or the Business that they are related to.

If you want to keep an up-to-date list of ongoing conversations for your businesses, we recommend using the Message Received and Message Deleted Webhooks instead of periodically calling this endpoint.

⚠️ This endpoint is paginated using cursor pagination. This means that in order to get the next page of results, you need to provide the cursor returned in the previous call.

get/conversations

Query parameters

per_pageinteger

Number of items to return per page.

cursorstring

The cursor identifiying the page of data to fetch. If no cursor is provided, the query will return the first page of data. A cursor for the next page of data is provided in the response of this request.

business__inBusinessId[]

Filter by business ids. Use a comma-separated list to provide multiple ids.

[
  "5409c35a97bbc544d8e26737"
]

Response

OK

countinteger

Total number of results available for the filters and dimensions requested.

next_cursorstring nullable

The cursor to use in order to retrieve the next page of data. When all data have been fetched, the value is null.

Example response

{
  "conversations": [
    {
      "consumer_img": "https://www.example.com/profile-picture.jpg",
      "consumer_name": "John Doe",
      "consumer_phone_number": "+33612345678",
      "consumer_email": "john.doe@example.com",
      "last_message": {
        "date": "2023-01-31 16:22:17.327878+00:00",
        "sender_label": "Jane Doe"
      },
      "created_at": "2023-01-31 16:22:17.327878+00:00",
      "messaging_partner": "Facebook",
      "issues": [
        "facebook_no_page_linked"
      ],
      "assigned_user_id": "62d80fae74e8b11d700302b8"
    }
  ],
  "count": 1
}