v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Conversations

Search Conversations

This endpoint doesn't consume Apollo credits. Learn more about API pricing and credits.

<a href="https://knowledge.apollo.io/hc/en-us/articles/45998035787533-Use-Conversations">Conversations</a> are prospect video meetings stored in Apollo.<br><br>Use the Search Conversations endpoint to find a list of conversations. Several filters are available to help narrow your search, including by type, account, contact, date range, and more. Each result includes a summary of the conversation.<br><br>This endpoint doesn't include transcripts or recording URLs. Use the conversation ID retrieved from your search to request full details using <a href="https://docs.apollo.io/docs/get-conversations-info">Get Conversations Info</a>.

post/conversations/search

Request body

pageinteger

Page number for pagination.

num_fetch_resultinteger

Maximum number of results to return.

conversation_type'video_conference' | 'phone_call'

Filter by dialer calls, or video conference calls.

account_idstring

Filter by account ID.

contact_idsstring[]

Filter by one or more contact IDs.

tag_idsstring[]

Filter by label or tag IDs.

tracker_idsstring[]

Filter by tracker IDs.

organization_idsstring[]

Filter by organization IDs.

scorecard_template_idstring

Filter by scorecard template ID.

scorecard_max_ratingnumber

Maximum scorecard rating to include in the results.

sort_by_fieldstring

Field to sort results by.

enforce_contact_boundaryboolean

When <code>true</code>, restricts results to conversations visible to the specified contacts.

Response

200

paginationobject

Pagination metadata for the result set.

breadcrumbsobject

Breadcrumbs data associated with the results.

num_fetch_resultinteger

Number of results returned.

playlist_clip_idsstring[] nullable

IDs of playlist clips associated with the results.