GET /api/v1/leads
List your leads.

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
  lead	Lead
  lead_grid	Lead Grid
  lead_external	Lead External

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
• context_menu_name
• name
• caller_id
• email
• full_name
• contact_field_type
• expires_in
• country
• state_province
• zip_postal_code
• time_zone
• sub_id
• offer_id
• schedule_id
• status
• human_status
• css_status
• has_next_action
• opt_out
• revenue
• payout
• offer_converted
• buyer_converted
• traffic_source_id
• buyer_id
• lead_import_id
• remote_ip
• attempted_call_id
• connected_call_id
• scheduled_callback_id
• call_buyer_conversion_id
• call_offer_conversion_id
• sms_number_id
• dial_number_id
• dial_tier
• last_action_at
• first_action_at
• first_queued_at
• schedule_ended_at
• next_action_at
• last_call_at
• is_live
• schedule_trigger_type
• blocked
• data

• 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

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.

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

Refer to the offer api for details

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Schedule internal id.

• Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules

Match calls that were placed by this caller.

• Must be a valid foreign key reference to an Contact. Refer to: /api/docs/1.0/contacts

Refer to the traffic source api for details

• Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

Refer to the buyer api for details

• Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

Match results that have this status.

• Must be a String

Filter for leads that are waiting before performing an action.

• Must be a String

Filter for leads matching this callerid.

• Must be a String

The email address for the lead. The lead's email is required for sending emails from schedules to leads.

• Must be a String

Filter for leads that have more actions to perform.

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

Select leads that have converted.

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

Select leads where a traffic source converted.

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

Select leads where either a buyer or traffic source converted.

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

Select leads that have opted-out.

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