API documentation

GET /call_routers

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/call_routers

List Call Flow records.

Lists the Call Flow rules that control call handling, exception handling, and hold queue handling on offers. Filter by offer_id to scope to a single offer.

Params

Param name	Description
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
offer_id Optional	Assign the record to this Offer. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
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 category name context_menu_name offer_id message_type message_action message_loop text_to_speech text_to_speech_gender router_action action_option buyer_ids buyer_offer_ids buyer_group_ids sortable_order schedule_id outbound_timeout_seconds router_type description message_action_type key_press_timeout_seconds perform_action_if_buyer_is_available inbound_call_route_async backup_buyer_ids backup_buyer_group_ids use_sound_playlist sound_playlist_id hold_music_sound_playlist_id voicemail_sound_playlist_id has_schedule has_extension_pool allows_outgoing_webhooks use_with_find_a_buyer use_with_key_press_flows key_press_flow_group_id auto_retry_next_buyer auto_retry_next_buyer_seconds has_extension_actions has_schedule_action can_dial can_alter_traffic_source max_call_disposition_wait_seconds hold_queue_caller_limit hold_queue_percentage_size max_hold_seconds max_hold_seconds_average fire_call_router_webhooks_before_action action_digit off_hook_calls_per_seat off_hook_unaccepted_wait off_hook_leads_needed audio_file_url voicemail_file_url hold_music_file_url call_router_hangup_reason call_router_answer_group_id off_hook_no_lead_timeout outgoing_webhook_ids after_action_sound_playlist_enabled after_action_sound_playlist_id off_hook_dropped_call_seconds off_hook_drop_limit_1 off_hook_drop_cps_1 off_hook_drop_limit_2 off_hook_drop_cps_2 enabled record_token_filter_id record_token_filter_data_count record_token_filter_data record_token_additional_id record_token_additional_data_count record_token_additional_data record_token_buyer_id record_token_buyer_data_count record_token_buyer_data off_hook_dropped_calls 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.com/api/v1/call_routers/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "call_routers": [
    {
      "id": 10001,
      "type": "CallRouter",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "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": "/call_routers/10001",
      "routes_edit_path": "/call_routers/10001/edit",
      "external_record_id": null,
      "category": "call_handling",
      "name": "When Getting Instant Agents On The Phone",
      "context_menu_name": "10001 - IA Flow",
      "offer_id": 10002,
      "message_type": "speak",
      "message_action": "82",
      "message_loop": 2,
      "text_to_speech": "We have prospects available. Press 1 if you want to remain on the line.",
      "text_to_speech_gender": "Female",
      "router_action": "dial",
      "action_option": "0",
      "buyer_ids": [
        10003,
        10004,
        10005
      ],
      "buyer_offer_ids": [],
      "buyer_group_ids": [],
      "sortable_order": -2,
      "schedule_id": null,
      "outbound_timeout_seconds": 30,
      "router_type": "off_hook_press_to_accept",
      "description": null,
      "message_action_type": "off_hook_press_to_accept",
      "key_press_timeout_seconds": null,
      "perform_action_if_buyer_is_available": null,
      "inbound_call_route_async": null,
      "backup_buyer_ids": null,
      "backup_buyer_group_ids": null,
      "use_sound_playlist": false,
      "sound_playlist_id": null,
      "hold_music_sound_playlist_id": null,
      "voicemail_sound_playlist_id": null,
      "has_schedule": false,
      "has_extension_pool": false,
      "allows_outgoing_webhooks": false,
      "use_with_find_a_buyer": null,
      "use_with_key_press_flows": null,
      "key_press_flow_group_id": null,
      "auto_retry_next_buyer": true,
      "auto_retry_next_buyer_seconds": 5,
      "has_extension_actions": false,
      "has_schedule_action": false,
      "can_dial": true,
      "can_alter_traffic_source": false,
      "max_call_disposition_wait_seconds": null,
      "hold_queue_caller_limit": null,
      "hold_queue_percentage_size": null,
      "max_hold_seconds": null,
      "max_hold_seconds_average": null,
      "fire_call_router_webhooks_before_action": false,
      "action_digit": null,
      "off_hook_calls_per_seat": 1.0,
      "off_hook_unaccepted_wait": 300,
      "off_hook_leads_needed": 1,
      "audio_file_url": null,
      "voicemail_file_url": null,
      "hold_music_file_url": "https://files.example.com/ith_chopin-15-2.mp3",
      "call_router_hangup_reason": null,
      "call_router_answer_group_id": null,
      "off_hook_no_lead_timeout": 43200,
      "outgoing_webhook_ids": [],
      "after_action_sound_playlist_enabled": null,
      "after_action_sound_playlist_id": null,
      "off_hook_dropped_call_seconds": 28800,
      "off_hook_drop_limit_1": 2,
      "off_hook_drop_cps_1": "2.0",
      "off_hook_drop_limit_2": 4,
      "off_hook_drop_cps_2": "1.0",
      "enabled": true,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": [],
      "record_token_additional_id": null,
      "record_token_additional_data_count": 0,
      "record_token_additional_data": [],
      "record_token_buyer_id": null,
      "record_token_buyer_data_count": 0,
      "record_token_buyer_data": [],
      "off_hook_dropped_calls": null
    },
    {
      "id": 10008,
      "type": "CallRouter",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T14:30:00.000Z",
      "updated_at": "2026-01-15T14:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/call_routers/10008",
      "routes_edit_path": "/call_routers/10008/edit",
      "external_record_id": null,
      "category": "call_handling",
      "name": "Handle Call When No Keypress Is Requested",
      "context_menu_name": "10008 - Handle Call When No Keypress Is Requested",
      "offer_id": 10009,
      "message_type": "none",
      "message_action": "34",
      "message_loop": 0,
      "text_to_speech": null,
      "text_to_speech_gender": null,
      "router_action": "end_call",
      "action_option": "-15",
      "buyer_ids": [],
      "buyer_offer_ids": [],
      "buyer_group_ids": [],
      "sortable_order": -1,
      "schedule_id": null,
      "outbound_timeout_seconds": 30,
      "router_type": "no_greeting_is_played",
      "description": null,
      "message_action_type": "no_greeting_is_played",
      "key_press_timeout_seconds": null,
      "perform_action_if_buyer_is_available": null,
      "inbound_call_route_async": null,
      "backup_buyer_ids": null,
      "backup_buyer_group_ids": null,
      "use_sound_playlist": false,
      "sound_playlist_id": null,
      "hold_music_sound_playlist_id": null,
      "voicemail_sound_playlist_id": null,
      "has_schedule": null,
      "has_extension_pool": false,
      "allows_outgoing_webhooks": true,
      "use_with_find_a_buyer": null,
      "use_with_key_press_flows": null,
      "key_press_flow_group_id": null,
      "auto_retry_next_buyer": true,
      "auto_retry_next_buyer_seconds": 5,
      "has_extension_actions": false,
      "has_schedule_action": false,
      "can_dial": true,
      "can_alter_traffic_source": false,
      "max_call_disposition_wait_seconds": null,
      "hold_queue_caller_limit": null,
      "hold_queue_percentage_size": null,
      "max_hold_seconds": null,
      "max_hold_seconds_average": null,
      "fire_call_router_webhooks_before_action": false,
      "action_digit": null,
      "off_hook_calls_per_seat": 1.0,
      "off_hook_unaccepted_wait": 300,
      "off_hook_leads_needed": 1,
      "audio_file_url": null,
      "voicemail_file_url": null,
      "hold_music_file_url": "https://files.example.com/ith_chopin-15-2.mp3",
      "call_router_hangup_reason": null,
      "call_router_answer_group_id": null,
      "off_hook_no_lead_timeout": 43200,
      "outgoing_webhook_ids": [],
      "after_action_sound_playlist_enabled": null,
      "after_action_sound_playlist_id": null,
      "off_hook_dropped_call_seconds": 28800,
      "off_hook_drop_limit_1": 2,
      "off_hook_drop_cps_1": "2.0",
      "off_hook_drop_limit_2": 4,
      "off_hook_drop_cps_2": "1.0",
      "enabled": true,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": [],
      "record_token_additional_id": null,
      "record_token_additional_data_count": 0,
      "record_token_additional_data": [],
      "record_token_buyer_id": null,
      "record_token_buyer_data_count": 0,
      "record_token_buyer_data": [],
      "off_hook_dropped_calls": null
    }
  ],
  "metadata": {
    "root": "call_routers",
    "page": 1,
    "total_pages": 403,
    "per_page": 2,
    "total_count": 805,
    "next_cursor": 10010
  }
}

Params

Must be any combination of: