v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Conversations

Get Conversations Info

This endpoint consumes 1 Apollo credit per conversation if the conversation has AI insights. If the conversation doesn't have AI insights, the request consumes 0 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 Get Conversation Info endpoint to retrieve the full details of a single conversation by its ID.<br><br>To get a conversation's ID, refer to <a href="https://docs.apollo.io/docs/search-conversations">Search Conversations</a>.

get/conversations/{id}

Path parameters

idstring required

The conversation ID. Supports an optional share ID in the format <code>id_shareid</code>

Response

200

idstring

Unique conversation ID.

topicstring

Conversation topic or title.

start_timestring

Conversation start time (ISO 8601). Apollo uses Greenwich Mean Time (GMT) for all date and time values.

durationinteger

Duration of the conversation in seconds.

statestring

Current processing state of the conversation.

hoststring

Name of the conversation host.

host_idstring

User ID of the conversation host.

is_privateboolean

Privacy setting of the conversation.

pushed_to_crmboolean

Whether the conversation has been pushed to a CRM.

account_idsstring[]

IDs of accounts associated with the conversation.

label_id_namesstring[]

Map of label IDs to label names associated with the conversation.

is_shared_conversationboolean

Whether the conversation has been shared.

opportunity_idsstring[]

IDs of opportunities associated with the conversation.

comment_countinteger

Number of comments on the conversation.

failure_codestring nullable

Error code if the conversation processing failed. Returns <code>null</code> if no failure occurred.

bot_call_ended_reasonstring nullable

Reason the bot call ended. Returns <code>null</code> if not applicable.

conversation_type'video_conference' | 'phone_call'

Type of conversation.

is_clipboolean

Whether the conversation is a clip.

transcriptobject[]

Transcript of the conversation.

playlist_clip_idsstring[] nullable

IDs of the playlist clips associated with the conversation.