Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:20

Maximum number of calls to return (default: 20, max: 100)

Required range: 1 <= x <= 100
Example:

20

after
string

Cursor for pagination - use the nextCursor value from a previous response

Example:

"eyJzb3J0VmFsdWUiOiIyMDI1LTAxLTE1VDEwOjAwOjAwLjAwMDAwMFoiLCJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"

sortBy
enum<string>
default:createdAt

Field to sort by (default: createdAt)

Available options:
createdAt,
startedAt,
endedAt,
duration,
title,
status
Example:

"createdAt"

sortDirection
enum<string>
default:desc

Sort direction (default: desc)

Available options:
asc,
desc
Example:

"desc"

status
enum<string>

Filter by call status

Available options:
RINGING,
IN_PROGRESS,
ENDED
Example:

"ENDED"

searchText
string

Search text to filter calls by title, summary, or transcript

Example:

"billing inquiry"

simulationRunPlanJobId
string<uuid>

Filter by simulation run plan job ID to get all calls from a specific simulation batch

Example:

"550e8400-e29b-41d4-a716-446655440000"

simulationRunPlanJobIds
string

Calls from any of these simulation runs (run plan job ids), comma-separated, at most 100

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(,[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})*$
Example:

"550e8400-e29b-41d4-a716-446655440000,660e8400-e29b-41d4-a716-446655440001"

simulationRunPlanIds
string

Calls from every run of any of these run plans, comma-separated, at most 100

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(,[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})*$
Example:

"770e8400-e29b-41d4-a716-446655440002"

countedInResults
enum<string>

true: only simulated calls their run's results count (not invalidated, for example because the agent never spoke). false: only the simulated calls the results leave out, each invalidated. Live calls, and calls removed from their run, match neither.

Available options:
true,
false
Example:

"true"

excludeHiddenRuns
enum<string>

true: leave out calls from runs hidden from the runs list. Live calls stay in. false is the same as leaving it out.

Available options:
true,
false
Example:

"true"

Response

List of calls

data
CallResponse · object[]
required
pagination
object
required