Search phone call legs

post

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

Searchable list of call-detail records, one row per call leg.

Use POST /phone_calls/list for the grouped parent-call view. Filter and
paginate with first, offset, and after; continue with the
previous page_info.end_cursor. count is a top-level response field
and is populated only when include_count=true.

Body Params

Filters and pagination for POST /phone_call_legs/list.

first

integer

required

1 to 200

Maximum call legs to return.

offset

integer

required

0 to 5000

Number of matching call legs to skip before this page.

include_archived

boolean

Defaults to false

When true, include archived call legs. Default false.

include_count

boolean

Defaults to false

When true, populate the top-level count field. Default false.

starts_at

Filter call legs by start time.

ends_at

Filter call legs by end time.

after

length ≤ 128

Cursor from the previous response's page_info.end_cursor.

length ≤ 128

Free-text filter for call legs.

user_ids

array of strings

length ≤ 50

Restrict results to these numeric platform user IDs.

User Ids

call_types

array of objects

length ≤ 100

Restrict results to these call types.

Call Types

numbers

array of strings

length ≤ 100

Restrict results to call legs involving any of these phone numbers.

Numbers

keyword_values__include_and

array of strings

length ≤ 100

Require call legs to contain every supplied keyword value.

Keyword Values Include And

tag_values__include_and

array of strings

length ≤ 100

Require call legs to have every supplied tag value.

Tag Values Include And

tag_values__exclude

array of strings

length ≤ 100

Exclude call legs with any supplied tag value.

Tag Values Exclude

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 phone call legs, 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).