List Conversations

List conversations matching the specified criteria. Returns all conversation if no criteria provided.

Note, Responses may time out if no criteria are specified. To prevent this, you can adjust the timeout using the Timeout feature in the action’s settings.

External Documentation

To learn more, visit the Chorus documentation.

​

Basic Parameters

Parameter	Description
Engagement IDs	A comma-separated list of Engagement ID(s) to filter by.
Engagement Type	The type of engagements to retrieve. If not specified, both types of conversations will return.
Max Date	Max date of engagement to filter by.
Min Date	Min date of engagement to filter by.
Participants Email	A single email address of a participant to filter by.
Return All Pages	Automatically fetch all resources, page by page.
Team IDs	A comma-separated list of Team ID(s) for engagement owner to filter by.
User IDs	A comma-separated list of User ID(s) for engagement owner to filter by.
With Trackers	Select to return trackers information with the results.

​

Advanced Parameters

Parameter	Description
Continuation Key	Continuation key for pagination.
Disposition Connected	Select to include conversations where the call was connected.
Disposition Gatekeeper	Select to include conversations where the call reached a gatekeeper.
Disposition Tree	Select to include conversations where the call encountered a phone tree.
Disposition Voicemail	Select to include conversations where the call resulted in voicemail.

​

Example Output

{
	"continuation_key": "<string>",
	"engagements": [
		{
			"account_id": "<string>",
			"account_name": "<string>",
			"action_items": [
				"<string>",
				"<string>"
			],
			"compliance": "<string>",
			"date_time": 1700611861,
			"disposition_connected": null,
			"disposition_gatekeeper": null,
			"disposition_tree": null,
			"disposition_voicemail": null,
			"duration": 1590,
			"engagement_id": "<string>",
			"engagement_type": "<string>",
			"initiator": null,
			"is_video_audio": "<string>",
			"language": "<string>",
			"meeting_summary": "<string>",
			"no_show": false,
			"num_cust_questions": 8,
			"num_engaging_questions": 2,
			"opportunity_id": "<string>",
			"opportunity_name": "<string>",
			"participants": [
				{
					"company_name": "<string>",
					"email": "<string>",
					"name": "<string>",
					"person_id": 140127544,
					"title": "<string>",
					"type": "<string>",
					"user_id": 1215764
				},
				{
					"company_name": "<string>",
					"email": "<string>",
					"name": "<string>",
					"person_id": 201442668,
					"title": "<string>",
					"type": "<string>",
					"user_id": 1478347
				}
			],
			"processing_state": "<string>",
			"subject": "<string>",
			"thread_id": null,
			"url": "<string>",
			"user_email": "<string>",
			"user_id": 568499,
			"user_name": "<string>"
		},
		{
			"account_id": "<string>",
			"account_name": "<string>",
			"action_items": [
				"<string>"
			],
			"compliance": "<string>",
			"date_time": 213645864,
			"disposition_connected": null,
			"disposition_gatekeeper": null,
			"disposition_tree": null,
			"disposition_voicemail": null,
			"duration": 256,
			"engagement_id": "<string>",
			"engagement_type": "<string>",
			"initiator": null,
			"is_video_audio": "<string>",
			"language": "<string>",
			"meeting_summary": "<string>",
			"no_show": false,
			"num_cust_questions": 2,
			"num_engaging_questions": 2,
			"opportunity_id": "<string>",
			"opportunity_name": "<string>",
			"participants": [
				{
					"company_name": "<string>",
					"email": "<string>",
					"name": "<string>",
					"person_id": 93879904,
					"title": "<string>",
					"type": "<string>",
					"user_id": 456359
				},
				{
					"company_name": "<string>",
					"email": "<string>",
					"name": "<string>",
					"person_id": 158747038,
					"title": "<string>",
					"type": "<string>",
					"user_id": null
				}
			],
			"processing_state": "<string>",
			"subject": "<string>",
			"thread_id": null,
			"url": "<string>",
			"user_email": "<string>",
			"user_id": 181905,
			"user_name": "<string>"
		}
	]
}