List Conversations (POST)
Lists the available conversations.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
actual_close_date
Provides ways to specify date ranges on objects.
applies_to_parts
Filters for conversations belonging to any of the provided parts.
brand
Filters for tickets that are associated with any of the brands.
channels
Filters for conversations that are associated with any of the
channels.
cursor
The cursor to resume iteration from. If not provided, then
iteration starts from the beginning.
custom_fields
Filters for custom fields.
group
Filters for conversation that belong to the given groups.
is_creator_verified
Filters for conversations that are created by verified users.
is_frozen
Filters for conversations that are frozen.
is_spam
Filters for conversations that are spam.
limit
The maximum number of conversations to return. The default is '50'.
members
Filters for conversations where these users are participants.
mode
The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.
Allowed values:
modified_date
owned_by
Filters for conversations owned by any of these users.
rev_orgs
Filters for conversations that are associated with any of the
provided Rev organizations.
sla_summary
The filter for SLA summary.
source_channel
Filters for conversations with any of the provided source channels.
source_channel_v2
Filters for conversations that are associated with the source
channel.
stage
The filter for stages.
state
Filters for conversations with any of the provided states.
subtype
Filters for conversation with any of the provided subtypes.
rev_orgDeprecated
Filters for conversations that are associated with any of the
provided Rev organizations.
source_channelsDeprecated
Filters for conversations with any of the provided source channels.
Response
The response to listing the conversations.
conversations
The list of conversations.
next_cursor
The cursor used to iterate subsequent results in accordance to the
sort order. If not set, then no later elements exist.
prev_cursor
The cursor used to iterate preceding results in accordance to the
sort order. If not set, then no prior elements exist.