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 a String

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

• Must be a String

Search for any record that matches this text

• Must be a 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
• concurrency_cap_limit
• concurrency_cap_used
• buyer_ids
• buyers_count
• company_id
• name
• maxed_out
• weight
• tier
• time_zone
• paused
• paused_at
• paused_by_user_id
• unpaused_at
• dial_buyers_type
• attempt_daily_used
• attempt_hourly_used
• attempt_monthly_used
• attempt_total_used
• buyer_conversion_daily_used
• buyer_conversion_hourly_used
• buyer_conversion_monthly_used
• buyer_conversion_total_used
• connection_daily_used
• connection_hourly_used
• connection_monthly_used
• connection_total_used
• earned_revenue_daily_used
• earned_revenue_hourly_used
• earned_revenue_monthly_used
• earned_revenue_total_used
• revenue_daily_used
• revenue_hourly_used
• revenue_monthly_used
• revenue_total_used
• attempt_daily_limit
• attempt_hourly_limit
• attempt_monthly_limit
• attempt_total_limit
• buyer_conversion_daily_limit
• buyer_conversion_hourly_limit
• buyer_conversion_monthly_limit
• buyer_conversion_total_limit
• connection_daily_limit
• connection_hourly_limit
• connection_monthly_limit
• connection_total_limit
• earned_revenue_daily_limit
• earned_revenue_hourly_limit
• earned_revenue_monthly_limit
• earned_revenue_total_limit
• revenue_daily_limit
• revenue_hourly_limit
• revenue_monthly_limit
• revenue_total_limit

• Must be a 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

Sort results by this field.

• Must be one of: name, maxed_out, weight, tier, cap_reset_at, time_zone, created_at, updated_at, paused, paused_at, paused_by_user_id, unpaused_at, user_updated_at, dial_buyers_type, call_limits.in_progress_count, call_limits.in_progress_used, call_limits.revenue_hourly_used, call_limits.revenue_daily_used, call_limits.revenue_monthly_used, call_limits.revenue_total_used, call_limits.earned_revenue_hourly_used, call_limits.earned_revenue_daily_used, call_limits.earned_revenue_monthly_used, call_limits.earned_revenue_total_used, call_limits.buyer_conversion_hourly_used, call_limits.buyer_conversion_daily_used, call_limits.buyer_conversion_monthly_used, call_limits.buyer_conversion_total_used, call_limits.connection_hourly_used, call_limits.connection_daily_used, call_limits.connection_monthly_used, call_limits.connection_total_used, call_limits.attempt_hourly_used, call_limits.attempt_daily_used, call_limits.attempt_monthly_used, call_limits.attempt_total_used.

Sort results in ascending or descending order.

• Must be one of: desc, asc.

The name of the buyer group.

• Must be a String

Pause or unpause.

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

Send true to reset the total caps on this buyer group.

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

Configure the dial buyer behaviour.
sequentially will dial one buyer a time.
simultaneously will dial all buyers in the group at the same time.

• Must be one of: sequentially, simultaneously.

The list of buyer ids that will be dialed.
Example: [100123, 100124, 1000125] Obtain internal buyer IDs by making a request to /api/v1/buyers?columns=name,id,user_buyer_id

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

When dial_buyers_type is set to simultaneously, the buyer group will become prioritized by tier and weight.
Buyers and Buyer Groups with the lowest tier are considered first for calls (a tier may be negative if needed).
For buyers/buyer groups with the same tier, the weight will then be used to calculate the % of calls the buyer/buyer group gets within that tier.

• Must be a decimal number.

When dial_buyers_type is set to simultaneously, the buyer group will become prioritized by tier and weight.
The Weight of this buyer group will be divided by the Total Weight of all buyers/buyer groups at this same Tier to get the % of calls this buyer/buyer group will get within this Tier.

• Must be a decimal number.

Grant access to manage this buyer group, it's buyers, and to view calls that it's paid for.

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

The selected users will recieve an email invitation to collaborate on your company.

• Must be an array of emails. EG: ["john-smith@gmail.com", "example@domain.com"]

Team members can view calls made to these Offers that were paid for by the buyers in this group.

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Attempt caps limit the number of times a buyer can be attempted in a given interval.

• Must be a decimal number.

Monthly Attempt Cap

• Must be a decimal number.

Daily Attempt Cap

• Must be a decimal number.

Connection caps limit the number of times a buyer can be connected in a given interval.

• Must be a decimal number.

Monthly Connection Cap

• Must be a decimal number.

Daily Connection Cap

• Must be a decimal number.

Conversion caps limit the number of times a buyer can convert in a given interval.

• Must be a decimal number.

Monthly Conversion Cap

• Must be a decimal number.

Daily Conversion Cap

• Must be a decimal number.

Revenue caps limit the dollar amount that can be paid by a buyer in a given interval.

• Must be a decimal number.

Monthly $ Revenue Cap

• Must be a decimal number.

Daily $ Revenue Cap

• Must be a decimal number.

Pause or unpause.

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

The name of the buyer group.

• Must be a String

Send true to reset the total caps on this buyer group.

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

Configure the dial buyer behaviour.
sequentially will dial one buyer a time.
simultaneously will dial all buyers in the group at the same time.

• Must be one of: sequentially, simultaneously.

Append buyers to this record.
For example pass: [100123,100124] in order to append 100123, and 100124 to the list of buyers in the record.
<strong>This is useful when making parallel PUT requests with different add_buyer_ids or remove_buyer_ids values. These add/remove assignments are thread safe.</strong>

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

Remove buyers from the record.
For example pass: [100123] in order to delete 100123 from the list of buyers in the record.

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

Append buyers to the record using the buyer field user_buyer_id
For example pass: ["loan-22-en", "loan-23-fr"]

• Must be an array of strings. EG: ["abc123", "xzy023"]

Remove buyers from the record using buyer field user_buyer_id
For example pass: ["loan-23-fr"]

• Must be an array of strings. EG: ["abc123", "xzy023"]

The list of buyer ids that will be dialed.
Example: [100123, 100124, 1000125] Obtain internal buyer IDs by making a request to /api/v1/buyers?columns=name,id,user_buyer_id

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

When dial_buyers_type is set to simultaneously, the buyer group will become prioritized by tier and weight.
Buyers and Buyer Groups with the lowest tier are considered first for calls (a tier may be negative if needed).
For buyers/buyer groups with the same tier, the weight will then be used to calculate the % of calls the buyer/buyer group gets within that tier.

• Must be a decimal number.

When dial_buyers_type is set to simultaneously, the buyer group will become prioritized by tier and weight.
The Weight of this buyer group will be divided by the Total Weight of all buyers/buyer groups at this same Tier to get the % of calls this buyer/buyer group will get within this Tier.

• Must be a decimal number.

Grant access to manage this buyer group, it's buyers, and to view calls that it's paid for.

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

The selected users will recieve an email invitation to collaborate on your company.

• Must be an array of emails. EG: ["john-smith@gmail.com", "example@domain.com"]

Team members can view calls made to these Offers that were paid for by the buyers in this group.

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Attempt caps limit the number of times a buyer can be attempted in a given interval.

• Must be a decimal number.

Monthly Attempt Cap

• Must be a decimal number.

Daily Attempt Cap

• Must be a decimal number.

Connection caps limit the number of times a buyer can be connected in a given interval.

• Must be a decimal number.

Monthly Connection Cap

• Must be a decimal number.

Daily Connection Cap

• Must be a decimal number.

Conversion caps limit the number of times a buyer can convert in a given interval.

• Must be a decimal number.

Monthly Conversion Cap

• Must be a decimal number.

Daily Conversion Cap

• Must be a decimal number.

Revenue caps limit the dollar amount that can be paid by a buyer in a given interval.

• Must be a decimal number.

Monthly $ Revenue Cap

• Must be a decimal number.

Daily $ Revenue Cap

• Must be a decimal number.