Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
Conversation

List Conversations (Optimized)

Optimized alias for GET /conversations. Uses a batch query path that pre-fetches edges in a single pass, making it significantly faster for large result sets. Behavioural differences from /conversations: (1) extractedIntelligence and confirmedExtractedIntelligence are omitted by default — pass with_crm_records=true to include them; (2) empty conversations are not excluded; All filter parameters are identical to /conversations.

get/conversations/list

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 (max 50)

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

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. Maximum 10 entries.

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 have not 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

Include import metadata in the response

detailedTranscriptboolean

Include detailed transcript information in the response

withCrmRecordsboolean

Include CRM records in the response. Also re-enables extractedIntelligence and confirmedExtractedIntelligence fields that are otherwise stripped on this endpoint.

withIntelligenceItemsboolean

Include intelligence items in the response

Response

Successfully retrieved conversations

Example response

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