GET /api/v1/contacts
Get contacts matching filters.

Supported Formats

json, csv

Examples

wget "https://[your-subdomain].trackdrive.net/api/v1/contacts?page=1&order=created_at&auth_token=[your-auth-token]"

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

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 String

created_at_from
optional

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

  • Must be String

fulltext
optional

Search for any record that matches this text

  • Must be String

time_zone
optional

Date ranges will be parsed using this time zone.

  • Must be one of: Etc/UTC, UTC, SST, HST, AKST, PST, MST, CST, EST, COT, PET, AST, VET, BOT, CLST, NST, BRST, ART, UYT, GYT, WGT, GST, AZOT, CVT, GMT, WET, CET, EET, MSK, IST, CAT, SAST, EAT, IRST, AZT, GET, AMT, AFT, YEKT, PKT, UZT, NPT, BDT, NOVT, MMT, ICT, WIB, KRAT, HKT, XJT, MYT, SGT, AWST, IRKT, ULAT, KST, JST, YAKT, ACST, ACDT, AEDT, AEST, VLAT, ChST, PGT, MAGT, SBT, NCT, FJST, PETT, MHT, NZDT, TOT, TKT, CHADT, WSDT.

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
  • number
  • created_at
  • last_call_at
  • blocked
  • Must be String

blocked
optional

Block or unblock a contact

  • Must be one of: true, false.

last_call_at_to
optional

Return records that received a call within this timeframe. Date formatted like 2016-01-01 12:00:15 -0500

  • Must be String

last_call_at_from
optional

Return records that received a call within this timeframe. Date formatted like 2016-01-01 12:00:15 -0500

  • Must be String

order
optional

Sort results by this field.

  • Must be one of: created_at, last_call_at, blocked, total_call_duration, calls_count, buyer_converted_count, revenue, offer_converted_count, payout, provider_cost, trackdrive_cost, total_call_duration.

order_dir
optional

Sort results in ascending or descending order.

  • Must be one of: desc, asc.


PUT /api/v1/contacts/:id
Update an individual contact

Supported Formats

json

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

blocked
optional

translation missing: en.api.contacts.update.blocked

  • Must be one of: true, false.


DELETE /api/v1/contacts/:id/calls
Hang up all the ongoing calls from a contact.

Examples

curl -i -X DELETE "https://[your-subdomain].trackdrive.net/api/v1/contacts/123/calls?auth_token=[your-auth-token]"

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

uuid
optional

A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1

  • Must be String