Skip to main content
GET
List available conversations.

Authorizations

Authorization
string
header
required

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

Query Parameters

name
string | null

Optional name of customer. Searches customer and profile in name, username and phone number.

status
enum<string>

Optional status of conversations. Status of a conversation.

Available options:
to-do,
in-progress,
done
channel
enum<string>

Optional channel of conversations. Type of messenger service.

Available options:
bridge,
whatsapp,
facebook,
widget
user_id
integer | null

Optional ID of assigned user. Setting to empty will return conversations without assigned user. When parameter is not set, conversations with or without assigned user will be returned.

agent_id
integer | null

Optional ID of agent.

customer_id
integer | null

Optional ID of customer.

folder_id
integer | null

Optional ID of assigned folder. Setting to empty will return conversations without assigned folder. When parameter is not set, conversations with or without assigned folder will be returned.

bot_id
integer | null

Optional ID of running bot. Setting to empty will return conversations without running bot. When parameter is not set, conversations with or without running bot will be returned.

tag_ids
integer | null

Optional IDs of tags assigned to the customer profile. Matches any of the given IDs.

group_ids
integer | null

Optional IDs of groups assigned to the customer profile. Matches any of the given IDs.

hide_empty
integer

Optional flag to hide conversations which have no messages.

Example:

1

hide_archived
integer

Optional flag to hide conversations that are archived. Default on!

Example:

1

hide_read
integer

Optional flag to hide all conversations that are already in "read" state.

Example:

1

expires_soon
integer

Optional flag to only show conversations that expire in the next 3 hours.

Example:

1

order_by_pinned
integer

Optional flag to order conversations by their pinned status (pinned first).

Example:

1

order_by_unread
integer

Deprecated: not supported anymore. Use the filter "hide_read" instead. Optional flag to order conversations by their unread customer message status (desc).

Example:

1

order_by_latest_message
integer

Optional flag to order conversations by their latest message sent_at field (desc). If not enabled, conversations will be ordered by their created_at field (desc).

Example:

1

pagination_mode
enum<string> | null
default:offset

Optional alternate mode of pagination. Default is offset (page by page). You can set to "cursor" to use cursor based pagination. This is useful to reproduce an endless scroll experience with updating conversations. Caution, when using cursor mode, the paginated result model changes slightly.

Available options:
offset,
cursor
per_page
integer

Optional number of conversations per page.

Response

200 - application/json

Success

data
object[]

Default count: 100

meta
object