API documentation

GET /contacts/suppression_list

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/contacts/suppression_list

List contacts on your company blacklist.

Returns the contacts your company has blocked - your do-not-call blacklist. A blocked contact cannot call or text in, and no outbound calls, SMS, or email are sent to it. Supports pagination and filtering by creation date or the date the contact was blocked. Requires the Suppression List permission.

Params

Param name	Description
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. Must be a valid time zone. See the list of valid time zones.
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 number last_call_at blocked opt_out calls_count outbound_call_failure_count outbound_no_answer_count blocked_at sms_opt_out_at 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

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/contacts/suppression_list' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "contacts": [
    {
      "id": 10001,
      "type": "Contact",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/contacts/10001",
      "routes_edit_path": "/contacts/10001/edit",
      "external_record_id": null,
      "number": "+19205559017",
      "last_call_at": null,
      "blocked": true,
      "opt_out": null,
      "calls_count": 0,
      "outbound_call_failure_count": 0,
      "outbound_no_answer_count": 0,
      "blocked_at": "2026-01-15T15:30:00.000Z",
      "sms_opt_out_at": null
    },
    {
      "id": 10002,
      "type": "Contact",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/contacts/10002",
      "routes_edit_path": "/contacts/10002/edit",
      "external_record_id": null,
      "number": "+18135559016",
      "last_call_at": null,
      "blocked": true,
      "opt_out": null,
      "calls_count": 0,
      "outbound_call_failure_count": 0,
      "outbound_no_answer_count": 0,
      "blocked_at": "2026-01-15T15:30:00.000Z",
      "sms_opt_out_at": null
    }
  ],
  "metadata": {
    "root": "contacts",
    "page": 1,
    "total_pages": 1,
    "per_page": 25,
    "total_count": 2,
    "next_cursor": 10003
  }
}

Params

Must be any combination of: