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]`
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 company_id user_id offer_id schedule_id owner_type status data_maps_set name data_json error_message import_count total_count paused_at started_at stopped_at failed_at succeeded_at recent_calls_count traffic_source_id lead_priority update_only sub_id off_hook_buyer_id paused pause_leads change_next_action_at set_next_action_at set_next_action_time_zone apply_data_to_calls manage_move_to_another_schedule manage_move_to_another_schedule_id manage_add_to_schedule manage_add_to_schedule_id manage_delete_lead created_count manage_schedule_action manage_opt_out_and_in manage_block_and_unblock record_token_additional_id record_token_additional_data_count record_token_additional_data 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