conversations

List Post

POST
Lists the available conversations.

Request

This endpoint expects an object.
applies_to_parts
list of stringsOptional
Filters for conversations belonging to any of the provided parts.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
group
list of stringsOptional
Filters for conversation that belong to the given groups.
is_creator_verified
booleanOptional
Filters for conversations that are created by verified users.
is_spam
booleanOptional
Filters for conversations that are spam.
limit
integerOptional
The maximum number of conversations to return. The default is '50'.
members
list of stringsOptional
Filters for conversations where these users are participants.
mode
enumOptional
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: afterbefore
owned_by
list of stringsOptional
Filters for conversations owned by any of these users.
rev_org
list of stringsOptional
Filters for conversations that are associated with any of the provided Rev organizations.
sla_summary
objectOptional
The filter for SLA summary.
source_channels
list of stringsOptional
Filters for conversations with any of the provided source channels.
stage
objectOptional
The filter for stages.
tags
list of stringsOptional
Filters for conversations with any of the provided tags.
tags_v2
list of objectsOptional
Filters for conversations with any of the provided tags with value.

Response

This endpoint returns an object
conversations
list of objects
The list of conversations.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
POST
1curl -X POST https://api.devrev.ai/conversations.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
1{
2  "conversations": [
3    {
4      "id": "id",
5      "members": [],
6      "created_date": "2023-01-01T12:00:00Z",
7      "description": "description",
8      "display_id": "display_id",
9      "group": {
10        "id": "id"
11      },
12      "modified_date": "2023-01-01T12:00:00Z",
13      "sla_tracker": {
14        "id": "id"
15      },
16      "stage": {
17        "name": "name"
18      },
19      "tags": [
20        {
21          "tag": {
22            "id": "id",
23            "name": "name"
24          }
25        }
26      ],
27      "title": "title"
28    }
29  ],
30  "next_cursor": "next_cursor",
31  "prev_cursor": "prev_cursor"
32}
Built with