Skip to main content
GET
Get Calls

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
business_unit_id__in
string[] | null

Filter by business unit IDs.

sentiment
enum<string>[] | null

Filter by one or more sentiment values.

Available options:
positive,
negative,
neutral,
unknown
classification
enum<string>[] | null

Filter by one or more call classification values.

Enumerates the possible classifications for an interaction (email or call).

Available options:
payment_inquiry,
payment_promise,
account_inquiry,
invoice_inquiry,
refund_request,
cancellation_request,
support_request,
complaint,
feedback,
wrong_contact,
message_forwarding_request,
cc_inclusion_request,
not_available,
contact_inquiry,
dispute,
resolution,
delivery_failure,
payment_processing_request,
other
direction
enum<string> | null

Filter by call direction.

Available options:
inbound,
outbound
partner_id
string | null

Filter by partner ID.

invoice_id
string | null

Filter by invoice ID.

workflow_id
string | null

Filter by workflow ID.

before
string<date-time> | null

Return calls that started or were created before this time.

after
string<date-time> | null

Return calls that started or were created after this time.

Response

Successful Response

data
CallList · object[]
required

The list of records.

current_page
integer
default:0
required

The current page.

total_records
integer | null
required

Total number of records.

Required range: x >= 0
next_page
integer | null
required

The next page number, if one exists.