GET /api/v1/calls
List calls.

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

• Must be a value contained in the pick list:
  

  Acceptable Value	Description
  call	Default response format.
  call_grid	Modern response format that returns various foreign keys for use with other API endpoints.

The API provides a technique called ‘cursoring' to paginate large result sets. Cursoring separates results into pages (the size of which are defined by the per_page request parameter) and provides a means to move backwards and forwards through these pages. To retrieve cursored results, you initially pass a cursor with a value of -1 to the endpoint. By default, an API endpoint that supports cursoring will assume -1 was passed as cursor if you do not provide one. The response to a cursored request will contain metadata.next_cursor. The next_cursor is the cursor that you should send to the endpoint to receive the next batch of responses. You will know that you have requested the last available page of results when the API responds with a next_cursor = 0.

• Must be a decimal number.

Return the next page of results.

• Must be a number.

How many results to return per page. The default is 25.

• Must be a number.

Date formatted like 2016-01-01 12:25:15 -0500

• Must be String

Date formatted like 2016-01-01 12:25:15 -0500

• Must be String

Search for any record that matches this text

• Must be String

Date ranges will be parsed using this time zone.

• Must be a valid time zone. See the list of valid time zones.

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
• name
• recording_url
• category
• number_called
• number_id
• connected_to
• caller_number
• offer
• user_offer_id
• offer_id
• quality_assurance_user_id
• quality_assurance_name
• quality_assurance_id
• agent_id
• traffic_source
• user_traffic_source_id
• traffic_source_id
• buyer
• user_buyer_id
• buyer_id
• obfuscated_caller_number
• caller_city
• caller_country
• token_values
• total_duration
• hold_duration
• ivr_duration
• attempted_duration
• answered_duration
• agent_duration
• sub_id
• schedule_id
• schedule_name
• ring_pool_id
• status
• buyer_converted
• buyer_repeat_caller
• buyer_revenue
• revenue
• traffic_source_converted
• traffic_source_repeat_caller
• traffic_source_payout
• payout
• trackdrive_cost
• provider_cost
• call_sid
• provider
• outgoing_webhooks_count
• ended_at
• contact_field_type
• disposition_id
• disposition_key
• disposition_name
• disposition_notes
• hangup_cause

• Must be String

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

Dynamic Date String such as “Today” or “This Year”

• Must be one of: Last 5 Min, Last 15 Min, Last 30 Min, Last Hour, Last 4 Hours, Last 6 Hours, Last 12 Hours, Last Day, Last 2 Days, Today, Yesterday, This Week, Last Week, This Month, Last Month, This Quarter, Last Quarter, Last 6 Months, This Year, Last Year, Lifetime, Custom Range.

Match calls where the Traffic Source had a repeat caller.

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Match calls where the Buyer had a repeat caller.

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Did the buyer convert?

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Did the traffic source convert?

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Match calls that are on-going

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Was the call placed on hold?

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Match calls that have a recording.

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Whether this call's buyer or traffic source has converted.

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Match calls where the callerID was a duplicate against the Buyer's conversion settings.

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Match calls where the callerID was a duplicate against the Traffic Source's conversion settings.

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Match calls that didn't connect to a Buyer

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.

• Must be String

Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345.

• Must be String

Sort results by this field.

• Must be one of: direction, start_app_duration, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, third_party_cost, charge_total, answered_duration, agent_duration, status, buyer_converted, revenue, offer_converted, payout, outgoing_webhooks_count, created_at, end_time, lead_id.

Sort results in ascending or descending order.

• Must be one of: desc, asc.

Refer to the number api for details

• Must be a decimal number.

Refer to the offer api for details

• Must be a decimal number.

Schedule internal id.

• Must be a decimal number.

Refer to the traffic source api for details

• Must be a decimal number.

Refer to the buyer api for details

• Must be a decimal number.

Buyer Group Internal ids.

• Must be a decimal number.

Refer to the Number Pool api for details

• Must be a decimal number.

An Integer number eg: 12345

• Must be a decimal number.

Refer to the provider api for details

• Must be a decimal number.

Match calls that were placed by this caller.

• Must be a decimal number.

Match results that have this status.

• Must be String

Date formatted like 2016-01-01 12:00:15 -0500

• Must be String

Date formatted like 2016-01-01 12:00:15 -0500

• Must be String