List Conversations

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.

custom_fieldsmap from strings to anyOptional

Filters for custom fields.

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.

mode"after" or "before"Optional

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.

rev_orgsstringOptional

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_channelstringOptional

Filters for conversations with any of the provided source channels.

source_channelsstringOptional

Filters for conversations with any of the provided source channels.

stage.namestringOptional

Filters for records in the provided stage(s) by name.

subtypestringOptional

Filters for conversation with any of the provided subtypes.

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

The response to listing the conversations.

conversationslist of objects

The list of conversations.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

GET

1 curl -G https://api.devrev.ai/conversations.list \
2      -H "Authorization: Bearer <token>" \
3      -d tags_v2.id=TAG-12345

200Retrieved

1 {
2   "conversations": [
3     {
4       "id": "id",
5       "members": [
6         {
7           "type": "sys_user",
8           "id": "members"
9         }
10       ],
11       "created_by": {
12         "type": "sys_user",
13         "id": "created_by"
14       },
15       "created_date": "2023-01-01T12:00:00Z",
16       "description": "description",
17       "display_id": "display_id",
18       "group": {
19         "id": "id"
20       },
21       "messages": [
22         {
23           "type": "timeline_comment",
24           "id": "messages",
25           "object": "messages",
26           "object_display_id": "messages",
27           "created_date": "2023-01-01T12:00:00Z",
28           "modified_date": "2023-01-01T12:00:00Z"
29         }
30       ],
31       "modified_by": {
32         "type": "sys_user",
33         "id": "modified_by"
34       },
35       "modified_date": "2023-01-01T12:00:00Z",
36       "owned_by": [
37         {
38           "type": "sys_user",
39           "id": "owned_by"
40         }
41       ],
42       "sla_summary": {
43         "target_time": "2023-01-01T12:00:00Z"
44       },
45       "sla_tracker": {
46         "id": "id"
47       },
48       "stage": {
49         "name": "name"
50       },
51       "tags": [
52         {
53           "tag": {
54             "id": "id",
55             "name": "name"
56           }
57         }
58       ],
59       "title": "title"
60     }
61   ],
62   "next_cursor": "next_cursor",
63   "prev_cursor": "prev_cursor"
64 }

Built with

1	curl -G https://api.devrev.ai/conversations.list \
2	-H "Authorization: Bearer <token>" \
3	-d tags_v2.id=TAG-12345

1	{
2	"conversations": [
3	{
4	"id": "id",
5	"members": [
6	{
7	"type": "sys_user",
8	"id": "members"
9	}
10	],
11	"created_by": {
12	"type": "sys_user",
13	"id": "created_by"
14	},
15	"created_date": "2023-01-01T12:00:00Z",
16	"description": "description",
17	"display_id": "display_id",
18	"group": {
19	"id": "id"
20	},
21	"messages": [
22	{
23	"type": "timeline_comment",
24	"id": "messages",
25	"object": "messages",
26	"object_display_id": "messages",
27	"created_date": "2023-01-01T12:00:00Z",
28	"modified_date": "2023-01-01T12:00:00Z"
29	}
30	],
31	"modified_by": {
32	"type": "sys_user",
33	"id": "modified_by"
34	},
35	"modified_date": "2023-01-01T12:00:00Z",
36	"owned_by": [
37	{
38	"type": "sys_user",
39	"id": "owned_by"
40	}
41	],
42	"sla_summary": {
43	"target_time": "2023-01-01T12:00:00Z"
44	},
45	"sla_tracker": {
46	"id": "id"
47	},
48	"stage": {
49	"name": "name"
50	},
51	"tags": [
52	{
53	"tag": {
54	"id": "id",
55	"name": "name"
56	}
57	}
58	],
59	"title": "title"
60	}
61	],
62	"next_cursor": "next_cursor",
63	"prev_cursor": "prev_cursor"
64	}