List of callback record objects.

{
  "total": 9,
  "page": 1,
  "per_page": 2,
  "total_pages": 5,
  "count": 2,
  "_links": {
    "self": { "href": "https://api.talkdeskapp.com/schedule-callbacks/?per_page=2&page=1" }
  },
  "_embedded": {
    "callbacks": [
      {
        "callback_id": "2da8a248-4b77-463e-9a36-d724f5792971",
        "interaction_id": "03e5c6f0-53c5-4b76-86ef-8d89ac67cdc6",
        "caller_id": "+155598754214",
        "status": "UNATTEMPTED",
        "phone_number": "+351910000000",
        "record_first_name": "Chandler",
        "record_last_name": "Bing"
      }
    ]
  }
}

Scope

schedule-callbacks:read

Query Parameters

Parameter	Type	Default	Description
page	integer	`1`	The page number to retrieve (Min: 1).
per_page	integer	`1`	Items per page (Max: 500).
agent_id	string		Filter by assigned agent ID (supports comma-separated list).
campaign_id	string		The campaign ID where the callback originated.
status	string		The status of the callback (e.g., UNATTEMPTED).
phone_number	string		The specific phone number to search for.

Example Request

curl --request GET \
     --url 'https://api.talkdeskstg.com/schedule-callbacks?page=1&per_page=2' \
     --header 'Accept: application/hal+json' \
     --header 'Authorization: Bearer YOUR_TOKEN'

Response Schema (200 OK)

Field	Type	Required	Description
`total`	integer	Yes	Total elements matching the query.
`page`	integer	Yes	Current page number.
`per_page`	integer	Yes	Items per page.
`total_pages`	integer	Yes	Total number of available pages.
`count`	integer	Yes	Number of elements in this current page.
`_embedded`	object	Yes	Container for the callbacks` array.

Success Response Example

{
  "total": 9,
  "page": 1,
  "per_page": 2,
  "total_pages": 5,
  "count": 2,
  "_links": {
    "self": {
      "href": "https://api.talkdeskapp.com/schedule-callbacks/?per_page=2&page=1"
    }
  },
  "_embedded": {
    "callbacks": [
      {
        "callback_id": "2da8a248-4b77-463e-9a36-d724f5792971",
        "status": "UNATTEMPTED",
        "phone_number": "+351910000000",
        "scheduled_time_to_call": "2021-03-24T11:48:40.500Z"
      }
    ]
  }
}

Error Codes

Status	Message
400	Bad Request - Validation error in parameters.
401	Unauthorized - Invalid or missing token.
403	Forbidden - Missing required scopes.