Skip to main content
GET
Export call records

Authorizations

Authorization
string
header
required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Query Parameters

projectId
string<uuid>

Project to read. Omit to total every project in the organization. Project tokens always read their own project.

sessionId
string

Session name of one number.

Required string length: 1 - 128
direction
enum<string>

Specifies direction for this query parameter.

Allowed values

Available options:
inbound,
outbound
upstream
enum<string>

How the number connects to WhatsApp.

Available options:
linked_device,
cloud_api
outcome
enum<string>

How the call went. answered: media connected, including answered calls still in progress. declined: declined by a participant or the other party, or the line was busy. missed: nobody answered before ringing stopped or the caller hung up. failed: ended before it connected for any other reason. in_progress: still ringing.

Available options:
answered,
missed,
declined,
failed,
in_progress
since
string<date-time>

Include calls that started at or after this time.

until
string<date-time>

Include calls that started before this time.

format
enum<string>
default:csv

Specifies format for this query parameter.

Allowed values

Available options:
csv,
ndjson
limit
integer
default:1000

Records per page, up to 1,000.

Required range: 1 <= x <= 1000
cursor
string

The Polymorfa-Next-Cursor value from the previous page. Send the same filters.

Required string length: 1 - 256

Response

One page of call detail records.

Header row, then one row per call. Columns: callId, projectId, sessionId, direction, upstream, outcome, state, hasVideo, peerRef, startedAt, connectedAt, endedAt, durationSeconds, endReason. Empty fields are null. Text that begins with =, +, -, @, tab or carriage return is prefixed with an apostrophe.