API documentation

Params

Param name	Description Validations
owner_id Optional	The ID for the record that owns this record. Validations: Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
owner_type Optional	The type of record that owns this record. Validations: Must be String
owner_relation Optional	The relation. Validations: Must be String
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 String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be String
fulltext Optional	Search for any record that matches this text Validations: Must be 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 owner_relation sortable_order color schedule open_times buyer_conversion_ids offer_conversion_ids offer_id traffic_source_id buyer_id time_zone buyer_conversion_hourly_limit buyer_conversion_hourly_used offer_conversion_hourly_limit offer_conversion_hourly_used connection_hourly_limit connection_hourly_used concurrency_limit revenue_hourly_limit revenue_hourly_used payout_hourly_limit payout_hourly_used attempt_hourly_limit attempt_hourly_used off_hook_concurrency_limit softphone_enabled day_parts buyer_type buyer_spacing_limit buyer_spacing_seconds buyer_spacing_minutes buyer_spacing_hours buyer_spacing_type buyer_spacing_interval Validations: Must be 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