Search phone calls

post

https://example.com/public-api/v1/phone_calls/list

Search parent phone-call records visible to the caller.

One parent call can contain multiple call legs. Use
POST /phone_call_legs/list when each result must be an individual leg.
Filter by time, user, number, type, keyword, tag, or free text; paginate
with first, offset, and after. count is populated only when
include_count=true. Nested details are populated only when
include_call_details=true.

Body Params

Request body for POST /phone_calls/list — search filters and pagination.

first

integer

1 to 200

Defaults to 50

Forward page size. 1 to 200.

offset

integer

0 to 5000

Defaults to 0

Number of matching calls to skip before this page. 0 to 5000.

after

length ≤ 128

Cursor from the previous response's page_info.end_cursor.

starts_at

Filter calls by start time.

ends_at

Filter calls by end time.

call_types

array of objects

length ≤ 100

Restrict results to these call types.

Call Types

numbers

array of strings

length ≤ 100

Restrict results to calls involving any of these phone numbers.

Numbers

user_ids

array of strings

length ≤ 100

Restrict results to these numeric platform user IDs.

User Ids

keyword_values__include_and

array of strings

length ≤ 100

Require calls to contain every supplied keyword value.

Keyword Values Include And

tag_values__include_and

array of strings

length ≤ 100

Require calls to have every supplied tag value.

Tag Values Include And

tag_values__exclude

array of strings

length ≤ 100

Exclude calls with any supplied tag value.

Tag Values Exclude

length ≤ 128

Free-text filter for call records.

include_archived

boolean

Defaults to false

When true, include archived calls. Default false.

include_count

boolean

Defaults to false

When true, populate count (costs an extra lookup). Default false.

include_call_details

boolean

Defaults to false

When true, populate each call's nested per-leg details array (participants, keywords, tags, audio analysis) — the same shape as GET /phone_calls/{id}. Default false, so list responses stay lightweight.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A page of matching parent phone calls, an optional matched count, and pagination cursors.

400The tenant could not be resolved from the request.

401Error envelope (public_api.unauthorized).

403The request is not allowed for the current tenant or access configuration.

404Error envelope (public_api.not_found).

409Error envelope (public_api.conflict).

413The request body exceeds the maximum allowed size.

422Validation Error

429Rate limit exceeded. Wait for Retry-After seconds before retrying.

502Error envelope (public_api.internal_error).

503The request could not be served right now. Please retry.

504Error envelope (public_api.request_timeout).