Communication

Calls

Call history. Read-only.

GET/calls

List calls

Returns the organization's call history. Carrier and provider identifiers are not exposed - they are operational internals with no integration use. Read-only. Requires scope: calls:read.

Parameters

Query

direction
string
Return only calls matching this direction.
status
string
Return only calls matching this status.
companyId
string
Return only calls matching this companyId.

Response 200

No fields.

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
429Rate limited
500Unexpected server error
GET/calls/{id}

Retrieve a call

Returns a single call by id. A record belonging to another organization returns 404 rather than 403. Requires scope: calls:read.

Parameters

Path

idrequired
string

Response 200

FieldTypeDescription
id
string
object
string
direction
enuminbound | outbound
nullable
from
string
Originating number in E.164 format.
to
string
Destination number in E.164 format.
customerPhone
string
The external party's number, whichever leg they were on.
status
string
Final call status reported by the carrier.nullable
durationSeconds
integer
nullable
agentName
string
The team member who handled the call, when there was one.nullable
companyId
string
nullable
companyName
string
nullable
createdAt
string <date-time>
updatedAt
string <date-time>
nullable

Errors

401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error