Communication
Calls
Call history. Read-only.
GET
/callsList 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
directionstring
Return only calls matching this direction.
statusstring
Return only calls matching this status.
companyIdstring
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
idrequiredstring
Response 200
FieldTypeDescription
idstring
objectstring
directionenuminbound | outbound
nullable
fromstring
Originating number in E.164 format.
tostring
Destination number in E.164 format.
customerPhonestring
The external party's number, whichever leg they were on.
statusstring
Final call status reported by the carrier.nullable
durationSecondsinteger
nullable
agentNamestring
The team member who handled the call, when there was one.nullable
companyIdstring
nullable
companyNamestring
nullable
createdAtstring <date-time>
updatedAtstring <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