Get list of CDRs

get

https://{defaultHost}/api/v4/reporting/cdrs

Returns a paginated list of Call Detail Records (CDRs). Use the cursor returned in metadata.next_cursor to continue fetching records beyond the first 10000 results. When cursor is not provided, pagination is limited to the first 10000 records using limit and offset.

Query Params

limit

integer

0 to 1000

Defaults to 100

The number of items to return.

offset

integer

≥ 0

Defaults to 0

The number of items to skip before starting to collect the result set. Ignored when a valid cursor is provided.

cursor

string

Cursor returned in the previous response metadata as next_cursor. Treat this value as an opaque token and pass it back unchanged. If both cursor and offset are provided: a valid cursor takes priority and offset is ignored. If cursor is invalid, the API falls back to offset-based pagination. If the fallback offset is also invalid, the API returns 400 Bad Request.

type

enum

Filter by CDR type. Accepts a single value or an array.

account_id

Filter by external account ID. Accepts a single value or an array.

subtype

enum

Filter by CDR subtype. Accepts a single value or an array.

disposition

enum

Filter by disposition. Accepts a single value or an array.

wrapup_code

Filter by wrap-up code. Accepts a single value or an array.

end_reason

enum

Filter by end reason. Accepts a single value or an array.

tag

enum

Filter by event tag. Accepts a single value or an array. Special value all_transfers expands to all transfer types.

from_phone_number

Filter by caller phone number. Accepts a single value or an array. Cannot be used with from_phone_number_like.

to_phone_number

Filter by destination phone number. Accepts a single value or an array of values. Cannot be used with to_phone_number_like.

from_phone_number_like

string

Filter by caller phone number pattern. Use * as a wildcard. Cannot be used with from_phone_number.

to_phone_number_like

string

Filter by destination phone number pattern. Use * as a wildcard. Cannot be used with to_phone_number.

from_channel_account_id

Filter by source channel account ID. Accepts a single value or an array.

to_channel_account_id

Filter by destination channel account ID. Accepts a single value or an array.

from_channel_profile_id

Filter by source channel profile ID. Accepts a single value or an array.

to_channel_profile_id

Filter by destination channel profile ID. Accepts a single value or an array.

user_id

Filter by user ID. Accepts a single value or an array.

team_id

Filter by team ID. Accepts a single value or an array.

queue_id

Filter by queue ID. Accepts a single value or an array.

campaign_id

Filter by campaign ID. Accepts a single value or an array.

related_call_id

Filter by related call ID. Accepts a single value or an array.

destination_country

Filter by destination country name. Accepts a single value or an array.

conversation_score

≥ 0

Filter by conversation score or score range.

duration_overall

≥ 0

Filter by overall duration (seconds) or by duration range.

duration_dialing

≥ 0

Filter by dialing duration (seconds) or by duration range.

duration_ivr

≥ 0

Filter by time spent in IVR (seconds) or by a duration range.

duration_queue

≥ 0

Filter by time spent in queue (seconds) or by a duration range.

duration_talk

≥ 0

Filter by time spent talking (seconds) or by a duration range.

duration_hold

≥ 0

Filter by time spent on hold (seconds) or by a duration range.

started_at

Filter by start time or by start time range.

ended_at

Filter by end time or by end time range.

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden