Search Calls

Search calls for an organization based on filters.

Optionally, the call records can be filtered by a set of filters:

  • before - will return call records created before the given date.
  • after - will return call records created after the given date.
  • from - will return call records from the given caller phone number.
  • to - will return call records to the given callee phone number.
  • direction - will return call records in the given direction.
  • delivery_status - will return call records with the given delivery status.
  • mode - will return call records with the given mode.
  • language - will return call records in the given language.
  • call_completion_rating - will return call records with the given call completion rating.
  • voicemail - will return call records with the given voicemail flag.
  • min_duration - will return call records with given minimum duration in milliseconds.
  • max_duration - will return call records with given maximum duration in milliseconds.
  • agent_id - will return call records from the given agent ID.
  • agent_version_id - will return call records from the given agent version ID.
  • contact_id - will return call records from/to the given contact ID.
  • conversation_id - will return call records from the given conversation ID.
  • channel_id - will return call records from/to the given channel ID.

All fields, with the exception of before, after, min_duration, max_duration, and voicemail, accept a single value or an array of values.

Supports two pagination methods. Cursor-based (cursor/limit) is stable and performant on large
datasets; it is triggered automatically when a cursor parameter is provided, and cursor and offset
cannot be combined. Offset-based (offset/limit) is also supported. Both methods return a metadata
object with a next_cursor field — pass it back as cursor to fetch the next page; when next_cursor is
null, there are no more results. Filters are not encoded in the cursor, so include them on every request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 50

limit

string

Cursor for keyset pagination. Use the next_cursor value from the previous response.

integer
Defaults to 0

offset

Body Params

Search Calls Request

Request schema for searching calls with extended filters.

date-time

The date and time after which the call records were created, in the ISO 8601 format.

uuid

Agent ID(s) to filter by.

Accepts a single value or an array.

uuid

Agent version ID(s) to filter by.

Accepts a single value or an array.

date-time

The date and time before which the call records were created, in the ISO 8601 format.

string
enum

Call completion rating.

Accepts a single value or an array.

Allowed:
uuid

Channel ID(s) to filter by.

Accepts a single value or an array.

uuid

Contact ID(s) to filter by.

Accepts a single value or an array.

uuid

Conversation ID(s) to filter by.

Accepts a single value or an array.

string

Call delivery status to filter by.

Accepts a single value or an array.

string
enum

Call direction.

Accepts a single value or an array.

Allowed:
string

Caller phone number(s).

Accepts a single value or an array.

string

Language code(s) to filter by.

Accepts a single value or an array.

integer
≥ 0

Maximum call duration in milliseconds

integer
≥ 0

Minimum call duration in milliseconds

string
enum

Call mode.

Accepts a single value or an array.

Allowed:
string

Callee phone number(s).

Accepts a single value or an array.

boolean

Whether the call is a voicemail.

Responses

Callback
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json