List Call Dispositions
Retrieve a paginated list of call dispositions with filtering options.
GET
Headers
x-api-keystringrequiredAPI key used for authenticating requests to the API.
x-workspace-idstringrequiredWorkspace identifier for the API.
Query Parameters
pagenumberdefault: 1Page number for pagination.
limitnumberdefault: 50Number of records per page.
phoneNumberstringFilter by phone number.
batchIdstringFilter by batch call ID.
agentIdstringFilter by agent ID.
statusstringFilter by disposition status.
dispositionstringFilter by disposition type.
attemptnumberFilter by attempt number.
searchstringSearch across dispositions.
timezonestringTimezone for date formatting (e.g., "America/New_York").
Response Fields
dataobjectPaginated disposition data.
dispositionsarrayArray of call disposition objects.
totalnumberTotal number of matching dispositions.
pagenumberCurrent page number.
limitnumberRecords per page.
totalPagesnumberTotal number of pages.
{
"data": {
"dispositions": [
{
"_id": "665a1b2c3d4e5f6a7b8c9d0e",
"phoneNumber": "+14155551234",
"disposition": "callback_scheduled",
"status": "pending",
"scheduledAt": "2024-06-02T14:00:00.000Z",
"attempt": 1,
"agentId": "665a1b2c3d4e5f6a7b8c9d0f",
"batchId": "665a1b2c3d4e5f6a7b8c9d10",
"createdAt": "2024-06-01T10:00:00.000Z"
}
],
"total": 25,
"page": 1,
"limit": 50,
"totalPages": 1
}
}