Sign in
Calls

List Calls

get/v2/call

Query parameters

assistantIdAnystring
Example:assistant-1,assistant-2,assistant-3

Filter by multiple assistant IDs. Provide as comma-separated values.

assistantOverridesobject

Filter by assistant overrides. Use variableValues to filter by template variables.

{
  "variableValues": {
    "name": "John",
    "age": "25"
  }
}
customerobject

Filter by customer properties. Supports filtering by number, name, externalId, and extension.

{
  "number": "+1234567890",
  "name": "John Doe"
}
customerNumberAnystring
Example:+1234567890,+0987654321

Filter by any of the specified customer phone numbers (comma-separated).

assistantIdstring

This will return calls with the specified assistantId.

assistantNamestring

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

squadIdstring

This will return calls with the specified squadId.

squadNamestring

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

idstring

This will return calls with the specified callId.

idAnystring[]

This will return calls with the specified callIds.

costLenumber

This will return calls where the cost is less than or equal to the specified value.

costGenumber

This will return calls where the cost is greater than or equal to the specified value.

costnumber

This will return calls with the exact specified cost.

successEvaluationstring

This will return calls with the specified successEvaluation.

endedReasonstring

This will return calls with the specified endedReason.

phoneNumberIdstring

This will return calls with the specified phoneNumberId.

phoneNumberIdAnystring[]

This will return calls with any of the specified phoneNumberIds.

structuredOutputsobject

Filter calls by structured output values. Use structured output ID as key and filter operators as values.

{
  "c9dddda4-d70a-4dad-aa5c-aaf117f85cea": {
    "eq": "2",
    "gt": "1"
  }
}
{"stackTrail":"paths:/v2/call:get:parameters:18:schema","oasType":"schema","type":"unknown","example":{"gte":80,"lt":100}}

Filter calls by the first scorecard's normalized score.

{
  "gte": 80,
  "lt": 100
}
pagenumber

This is the page number to return. Defaults to 1.

sortOrder'ASC' | 'DESC'

This is the sort order for pagination. Defaults to 'DESC'.

limitnumber

This is the maximum number of items to return. Defaults to 100.

createdAtGtstring date-time

This will return items where the createdAt is greater than the specified value.

createdAtLtstring date-time

This will return items where the createdAt is less than the specified value.

createdAtGestring date-time

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLestring date-time

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtstring date-time

This will return items where the updatedAt is greater than the specified value.

updatedAtLtstring date-time

This will return items where the updatedAt is less than the specified value.

updatedAtGestring date-time

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLestring date-time

This will return items where the updatedAt is less than or equal to the specified value.

Response

Changes