conversations

List

GET
Lists the available conversations.

Query parameters

applies_to_partsstringOptional
Filters for conversations belonging to any of the provided parts.
cursorstringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
groupstringOptional
Filters for conversation that belong to the given groups.
is_creator_verifiedbooleanOptional
Filters for conversations that are created by verified users.
is_spambooleanOptional
Filters for conversations that are spam.
limitintegerOptional
The maximum number of conversations to return. The default is '50'.
membersstringOptional
Filters for conversations where these users are participants.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values: afterbefore
owned_bystringOptional
Filters for conversations owned by any of these users.
rev_orgstringOptional
Filters for conversations that are associated with any of the provided Rev organizations.
sla_summary.stageenumOptional
Filters for records with any of the provided SLA stages.
Allowed values: breachedcompletedpausedrunningwarning
source_channelsstringOptional
Filters for conversations with any of the provided source channels.
stage.namestringOptional
Filters for records in the provided stage(s) by name.
tagsstringOptional
Filters for conversations with any of the provided tags.
tags_v2.idstringOptional
The ID of the tag.
tags_v2.valuestringOptional
The value for the object's association with the tag. If specified, the value must be one that's specified in the tag's allowed values.

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.
GET
1curl -G https://api.devrev.ai/conversations.list \
2     -H "Authorization: <apiKey>" \
3     -d tags_v2.id=TAG-12345
200
Retrieved
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