API documentation

GET /schedule_ring_pools

Authorization Required

https://[your-subdomain].trackdrive.net/api/v1/schedule_ring_pools

List Schedule Number Pool records.

List the number pools assigned to your schedules, in sort order, along with the filter group each assignment uses to decide when it applies.

Params

Param name	Description
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Must be a number.
per_page Optional	How many results to return per page. The default is 25. Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id company_id schedule_id ring_pool_id description sortable_order name context_menu_name record_token_filter_id record_token_filter_data_count record_token_filter_data Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.net/api/v1/schedule_ring_pools/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "schedule_ring_pools": [
    {
      "id": 10001,
      "type": "ScheduleRingPool",
      "uuid": null,
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": null,
      "routes_edit_path": "/schedule_ring_pools/10001/edit",
      "external_record_id": null,
      "company_id": 10002,
      "schedule_id": 10003,
      "ring_pool_id": 10004,
      "description": "Route After Hours Overflow through Toll-Free Tracking Pool",
      "sortable_order": 0,
      "name": "Toll-Free Tracking Pool",
      "context_menu_name": "Toll-Free Tracking Pool - Route After Hours Overflow through Toll-Free Tracking Pool",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    },
    {
      "id": 10005,
      "type": "ScheduleRingPool",
      "uuid": null,
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": null,
      "routes_edit_path": "/schedule_ring_pools/10005/edit",
      "external_record_id": null,
      "company_id": 10002,
      "schedule_id": 10006,
      "ring_pool_id": 10007,
      "description": "Route Primary Lead Distribution through Local Tracking Pool",
      "sortable_order": 0,
      "name": "Local Tracking Pool",
      "context_menu_name": "Local Tracking Pool - Route Primary Lead Distribution through Local Tracking Pool",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    }
  ],
  "metadata": {
    "root": "schedule_ring_pools",
    "page": 1,
    "total_pages": 2,
    "per_page": 2,
    "total_count": 4,
    "next_cursor": 10008
  }
}

Params

Must be any combination of: