List Calls

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Query Parameters

assistantOverridesobjectOptional
Filter by assistant overrides. Use variableValues to filter by template variables.
customerobjectOptional
Filter by customer properties. Supports filtering by number, name, externalId, and extension.
assistantIdstringOptional
This will return calls with the specified assistantId.
assistantNamestringOptional<=40 characters

This will return calls where the transient assistant name exactly matches the specified value (case-insensitive).

squadIdstringOptional
This will return calls with the specified squadId.
squadNamestringOptional

This will return calls where the transient squad name exactly matches the specified value (case-insensitive).

idstringOptional
This will return calls with the specified callId.
idAnylist of stringsOptional
This will return calls with the specified callIds.
costLedoubleOptional
This will return calls where the cost is less than or equal to the specified value.
costGedoubleOptional
This will return calls where the cost is greater than or equal to the specified value.
costdoubleOptional
This will return calls with the exact specified cost.
successEvaluationstringOptional<=1000 characters
This will return calls with the specified successEvaluation.
endedReasonstringOptional<=1000 characters
This will return calls with the specified endedReason.
phoneNumberIdstringOptional
This will return calls with the specified phoneNumberId.
structuredOutputsmap from strings to objectsOptional
Filter calls by structured output values. Use structured output ID as key and filter operators as values.
scoreanyOptional
Filter calls by the first scorecard's normalized score.
pagedoubleOptional>=1
This is the page number to return. Defaults to 1.
sortOrderenumOptional
This is the sort order for pagination. Defaults to 'DESC'.
Allowed values:
limitdoubleOptional0-1000
This is the maximum number of items to return. Defaults to 100.
createdAtGtdatetimeOptional
This will return items where the createdAt is greater than the specified value.
createdAtLtdatetimeOptional
This will return items where the createdAt is less than the specified value.
createdAtGedatetimeOptional
This will return items where the createdAt is greater than or equal to the specified value.
createdAtLedatetimeOptional
This will return items where the createdAt is less than or equal to the specified value.
updatedAtGtdatetimeOptional
This will return items where the updatedAt is greater than the specified value.
updatedAtLtdatetimeOptional
This will return items where the updatedAt is less than the specified value.
updatedAtGedatetimeOptional
This will return items where the updatedAt is greater than or equal to the specified value.
updatedAtLedatetimeOptional
This will return items where the updatedAt is less than or equal to the specified value.

Response

resultslist of objects
metadataobject