List Scheduled Callbacks

Returns a paginated list of scheduled callbacks with total count.
Use this endpoint to retrieve callbacks with optional filtering by status, phone number, agent, campaign, and time range.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

schedule-callbacks:read

Query Params
integer
1 to 500
Defaults to 1

page

integer
1 to 500
Defaults to 1

per page

date-time
length ≤ 35

The time the callback is scheduled

string
length ≤ 35

The phone number that is scheduled to be called.

string
length ≤ 35

The id of the contact that is scheduled to be called.

string
length ≤ 36

The id of the record that is scheduled to be called.

string
length ≤ 35

The status of callback

date-time
length ≤ 35

End of next time to call when status is 'UNATTEMPTED' or 'TO_BE_RETRIED'

string
length between 1 and 50

The assigned agent id of schedule callback. Return the callbacks which are specifically assigned to an agent (Myself only, Myself if available), or assigned to specific agents including her/him.
if want to filter by multiple agent id, agent_id=agent_id1,agent_id2

string
length ≤ 35

The campaign id of where the callback originates from.

date-time
length ≤ 35

Start of next time to call

date-time
length ≤ 35

End of next time to call

string
length between 1 and 100

The queue name. To filter by multiple queues, use comma-separated values (for example, queue=queue1,queue2).

string
length between 1 and 100

The ids of team, if want to filter by multiple team, team_id=123,345

string
length ≤ 64

Describes what call type is this related to, if want to filter by multiple call type, from_call_type=INBOUND,MANUAL_OUTBOUND

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json