API documentation

Params

Param name	Description Validations
ids Required	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 owner_id owner_type sortable_order conversion_type offer_id buyer_id traffic_source_id context_menu_name name revenue duration duplicate_timeframe cache_result_for_seconds business_range_id revenue_min revenue_max revenue_increment revenue_type webhook_response_success_codes webhook_body_success_path webhook_body_success_match webhook_path_number webhook_path_duration webhook_path_name webhook_path_revenue webhook_type webhook_remote_url webhook_read_timeout webhook_remote_method webhook_remote_body webhook_remote_headers token_value_map_ids webhook_path_external_id webhook_contains_many_buyers webhook_path_buyers webhook_response_buyers_limit webhook_response_buyers_order_by webhook_response_buyers_order_dir oauth_connection_id cache_success_for_seconds webhook_manual_fire_ids response_parser_ids webhook_response_buyers_max_duration_fallback webhook_response_buyers_max_duration token_value_map_group_ids webhook_conversion_type 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 webhook_params_count buyer_ping_parser_ids 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