Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
Conversation

List Conversations

Retrieves a paginated list of conversations with their transcriptions. Supports various filtering options to narrow down the results based on date ranges, participants, teams, and conversation status.

get/conversations

Query parameters

fromDateTimestring

Start date and time for filtering conversations (ISO 8601 format)

toDateTimestring

End date and time for filtering conversations (ISO 8601 format)

pageinteger

Page number for pagination (starts from 1)

sizeinteger

Number of items per page

filter[owner.id]string[]

Filter conversations by owner IDs

filter[owner.email]string[]

Filter conversations by owner email addresses

filter[title]string

Filter conversations by title using case-insensitive partial matching

filter[participants.email]string[]

Filter conversations by participant email addresses

filter[external_opportunity.id]string[]

Filter conversations by external opportunity IDs

filter[crm_field.entity_code]'companies' | 'contacts' | 'deals' | 'owners' | 'pipelines' | 'users' | 'account' | 'contact' | 'lead' | 'opportunity' | 'user'

CRM platform entity code to filter linked CRM records (e.g. companies, contacts, deals, owners, pipelines, users, account, contact, lead, opportunity, user)

filter[crm_field.field_name]string

CRM record field name (from org_crm_records.record_data) to match on linked CRM records

filter[crm_field.values]string[]

Exact values to match for the given CRM field. Values are OR'ed together.

filter[team.id]string[]

Filter conversations by team IDs

filter[hide_internal]boolean

Exclude internal conversations from results

filter[hide_non_analyzed]boolean

Exclude conversations that haven't been analyzed

filter[analyzed]boolean

Filter conversations by analysis status (deprecated, use filter[hide_non_analyzed] instead)

filter[hide_pending]boolean

Exclude conversations that are pending processing

filter[hide_transcript]boolean

Exclude conversations without transcripts

filter[hide_failed]boolean

Exclude conversations that failed processing

filter[include_internal_participants]boolean

Include internal participants in the response

filter[include_zoom_metadata]boolean

Include Zoom-specific metadata in the response

filter[include_import_metadata]boolean
detailedTranscriptboolean

Include detailed transcript information in the response

Response

Successfully retrieved conversations

Example response

{
  "data": [],
  "links": {
    "self": "/v2/conversations?page=1",
    "related": "/v2/conversations?page=2"
  },
  "meta": {
    "totalRecords": 150
  }
}