Skip to content
VaakyoDocs
Navigation
Open console →

Calls

List calls

GET/api/v1/calls

Calls in the workspace, newest first, without transcripts. Page with limit and skip; total is the number of calls matching the filters.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the calls.view permission.

X-API-KeyAuthorization: Bearercalls.view

Query parameters

sortstringdefault: "-created_at"

created_at, duration_seconds or cost_paise; a leading - for descending

at most 20 characters

limitintegerdefault: 50

How many to return.

1 to 200

skipintegerdefault: 0

How many to skip (for paging).

at least 0

agent_idstring

an agent id, or several comma-separated

at most 1400 characters

statusstring

comma-separated statuses

at most 80 characters

directionstring

outbound, inbound or web (comma-separated)

at most 40 characters

qstring

text in a number, the agent's name or the call id

at most 80 characters

batch_idstring

only the calls of this batch (campaign)

at most 64 characters

sincestring | null

created at or after this time (ISO 8601)

date-time

untilstring | null

created before this time (ISO 8601)

date-time

call_idstring

a call id or its beginning

at most 64 characters

phone_numberstring

the agent's number(s), comma-separated (caller id or dialled number)

at most 400 characters

customer_numberstring

the customer's number, or a part of it

at most 20 characters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Response

200Success.
itemsobject[]

Newest first, without the transcript.

Show item attributes
idstring

The call's id.

agent_idstring
agent_namestring
channelenum<string>default: "phone"

phone or web (a browser test call).

One of:phoneweb

directionenum<string>default: "outbound"

outbound, inbound or web.

One of:outboundinboundweb

from_numberstring
to_numberstring
statusenum<string>default: "queued"

Final states: completed, failed, no-answer, busy, canceled.

One of:queuedringingin-progresscompletedfailedno-answerbusycanceled

providerstringdefault: "plivo"
provider_call_idstring
provider_request_idstring
waiting_forstring
provider_accountstring
user_dataobject

What was passed when the call was placed.

transcriptobject[]

Every turn, in order (only on Get a call).

Show item attributes
roleenum<string>

One of:assistantusertool

textstring
atstring

date-time

interruptedbooleandefault: false
usageobject

Speech, voice and model usage.

Show child attributes
stt_secondsnumberdefault: 0
tts_charactersintegerdefault: 0
llm_input_tokensintegerdefault: 0
llm_output_tokensintegerdefault: 0
llm_callsintegerdefault: 0
recording_secondsnumberdefault: 0

Length of the recording; download it with Download a recording.

hangup_bystring

Who ended the call (agent, user, api, system, ...).

hangup_reasonstring
errorstring
created_atstring

date-time

answered_atstring | nulldefault: null

date-time

ended_atstring | nulldefault: null

date-time

duration_secondsnumberdefault: 0

From answer to hang-up.

first_audio_msinteger | nulldefault: null

Average time from the caller finishing a turn to the agent's first audio.

cost_paiseintegerdefault: 0

What the call cost the workspace, billed per second.

currencystring
cost_breakdownobject
plan_seconds_coveredintegerdefault: 0
providersobject
provider_cost_usdnumberdefault: 0
queued_atstring | nulldefault: null

When the call joined the queue (outbound calls).

date-time

dequeued_atstring | nulldefault: null

date-time

ignore_call_windowbooleandefault: false
summarystring

Post-call summary, when the agent's analytics ask for one.

extractedobject

Post-call extraction, when the agent's analytics ask for it.

guardrail_incidentsintegerdefault: 0
guardrail_severitystring
guardrail_checkobject
batch_idstring
batch_rowinteger | nulldefault: null
attemptintegerdefault: 1
answered_bystring
scheduled_forstring | nulldefault: null

date-time

rescheduled_fromstring
rescheduled_tostring
rescheduled_forstring | nulldefault: null

date-time

transferred_toobject
transferred_atstring | nulldefault: null

date-time

transfer_reasonstring
transfer_statusstring
transfer_secondsnumberdefault: 0
transfer_charged_paiseintegerdefault: 0
totalinteger

Calls matching the filters.

401No credentials, or they are invalid or revoked.
detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.
detailstring

What went wrong, in plain words.

422Validation Error
detailobject[]
Show item attributes
locstring | integer[]
msgstring
typestring
429Over the per-key rate limit; wait for Retry-After.
detailstring

What went wrong, in plain words.

Esc