API documentation

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
offer_id Optional	Assign the record to this Offer. Validations: 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. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: 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 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 off_hook_dropped_calls Validations: 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: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off