GET /leads

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/leads

List your leads.

Search and list leads in your account with filtering, sorting, and pagination. Also supports specialized modes for leads waiting on Instant Agent permission, leads with a scheduled callback ready to run, or currently live billable leads.

Params

Param name Description
serializer
Optional Blank value allowed

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 ValueDescription
    leadLead
    lead_gridLead Grid
    lead_externalLead External
page
Optional

Return the next page of results.

  • Must be a number.
per_page
Optional

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

  • Must be a number.
created_at_to
Optional

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

  • Must be a String
created_at_from
Optional

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

  • Must be a String
fulltext
Optional

Search for any record that matches this text

  • Must be a String
time_zone
Optional

Date ranges will be parsed using this time zone.
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
  • 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
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: {}}

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

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.
next_action_at_to
Optional

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

  • Must be a String
next_action_at_from
Optional

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

  • Must be a String
offer_id
Optional

Refer to the offer api for details
schedule_id
Optional

Schedule internal id.
contact_id
Optional

Match calls that were placed by this caller.
traffic_source_id
Optional

Refer to the traffic source api for details
buyer_id
Optional

Refer to the buyer api for details
status
Optional

Match results that have this status.

  • Must be a String
status_wait
Optional

Filter for leads that are waiting before performing an action.

  • Must be a String
number
Optional

The lead’s caller number. This is the number Trackdrive will dial when making outbound calls to the lead, and the number where Trackdrive will send SMS.

  • Must be a String
email
Optional

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

  • Must be a String
has_next_action
Optional

Filter for leads that have more actions to perform.

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

Select leads that have converted.

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

Select leads where a traffic source converted.

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

Select leads where either a buyer or traffic source converted.

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

Select leads that have opted-out.

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