Skip to navigation

List calls in a time window

View as Markdown

Returns your company’s calls whose start time falls in [from, to), newest first, with cursor pagination. Add include=transcript to receive transcripts inline. Each item carries the transcript and recording status so you know what can be fetched.

Authentication

X-Company-API-Keystring

Company API key with the calls:read scope, created in the SimZ portal under API Access.

Query parameters

fromdatetimeOptional

Inclusive lower bound on the call start time (ISO-8601 UTC). Defaults to to − 24h.

todatetimeOptional

Exclusive upper bound on the call start time (ISO-8601 UTC). Defaults to now. The window may be at most 31 days.

limitintegerOptional1-200Defaults to 50

Page size. 1–200 for metadata, 1–100 when include contains transcript.

includestringOptional

Comma-separated artifacts to return inline. Allowed values transcript, summary.

statusstringOptional

Comma-separated call statuses to keep, e.g. Completed,Transferred.

directionenumOptional
Allowed values:
agent_idstringOptional
Restrict to one of your agents.
cursorstringOptional

Opaque token from the previous page’s pagination.next_cursor. When present only limit may be sent alongside it; the window and filters travel inside the cursor. Cursors expire after 24 hours.

Response

A page of calls.
successbooleanOptional
request_idstringOptional
datalist of objectsOptional
paginationobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
503
Service Unavailable Error