List available conversations.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Optional name of customer. Searches customer and profile in name, username and phone number.
Optional status of conversations. Status of a conversation.
to-do, in-progress, done Optional channel of conversations. Type of messenger service.
bridge, whatsapp, facebook, widget 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.
Optional ID of agent.
Optional ID of customer.
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.
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.
Optional IDs of tags assigned to the customer profile. Matches any of the given IDs.
Optional IDs of groups assigned to the customer profile. Matches any of the given IDs.
Optional flag to hide conversations which have no messages.
1
Optional flag to hide conversations that are archived. Default on!
1
Optional flag to hide all conversations that are already in "read" state.
1
Optional flag to only show conversations that expire in the next 3 hours.
1
Optional flag to order conversations by their pinned status (pinned first).
1
Deprecated: not supported anymore. Use the filter "hide_read" instead. Optional flag to order conversations by their unread customer message status (desc).
1
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).
1
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.
offset, cursor Optional number of conversations per page.