Skip to main content
GET
Get call

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Path Parameters

id
string<uuid>
required

Response

Full call details

id
string<uuid>
agent_id
string<uuid>
from
string
to
string
direction
string
status
string
started_at
string<date-time> | null
ended_at
string<date-time> | null
duration_seconds
integer | null
metadata
object | null

The metadata object you attached at POST /calls. Empty object {} if no metadata was provided at call creation.

created_at
string<date-time>
ended_by
enum<string> | null

Who terminated the call. First-write-wins (a specific value like 'system' from voicemail detection is not overwritten by a later generic 'caller').

Available options:
caller,
agent,
system,
unknown
disconnect_reason
string | null

User-friendly reason the call ended (e.g. 'Completed', 'Voicemail detected'). First-write-wins.

transferred_at
string<date-time> | null

When the call was transferred (set only if status='transferred').

transfer_target
string | null

E.164 number or SIP URI the call was transferred to.

recording_url
string | null

Permanent signed URL for the call recording. Opens directly in a browser or audio player — redirects (302) to the audio file. No additional authentication required.

disposition
object | null

Full Disposition object. Present only when a disposition has been assigned.

lead
object | null

Full Lead object including long_term_context and tags. Present only when a matched lead exists.

summary
string | null

AI-generated call summary. Present only when available.

transcript
object[]

Full call transcript, ordered by time. Present only when available.

extracted_data
object

Structured fields extracted post-call by the agent's extraction_parameters. Present only when extraction ran and produced at least one value.

tool_calls
object[]

Paired request/response objects for each tool invocation during the call. Easier to consume than raw events. Auth-related headers (Authorization, tokens, keys) are redacted as [REDACTED].

events
object[]

Full ordered event stream for the call. Low-level — for flow agents prefer flow_trace (below). Auth headers in tool_called events are redacted.

flow_trace
object | null

Present only on flow-agent calls (agent.type='flow'). For prompt agents this field is omitted. Structured view of the call's path through the flow graph, built from the underlying flow_* events. For flow agents tool_calls[] is always empty — flow tool nodes use a separate dispatch path that emits flow_tool_result events (surfaced inline on each flow_trace.steps[].tool_call).