View as Markdown

List Blocked Companies

GET/v2/blocklist/companies

Lists the company domains on the workspace's block list, newest first, optionally filtered by a substring of the domain. Free, no credits; spends no rate-limit units, but counts against the per-second window of the search bucket. Blocked people and companies are left out of people and company search, people and company enrich, email find and suggestions in this workspace, within 15 seconds. Saving a person by id and email verify are not filtered by workspace block lists, and blocked domains that resolve to more than 10,000 companies are only partly excluded from people search. Any member or API key of the workspace may call it; a credential that belongs to no workspace answers 403.

Query parameters

  • querystringoptionalmin length: 2max length: 100

    Case-insensitive substring of the first or last name (people) or of the domain (companies). Matched as plain text.

  • pagenumberoptionalmin: 1default: 1

    The page, 1-based. Past the end: [] with the totals.

  • per_pagenumberoptionalmin: 1max: 100default: 25

    Entries per page.

Responses

  • 200 One page of entries, newest first.
  • 400 Invalid query (VALIDATION_ERROR): out_of_range (page below 1, per_page outside 1-100, query outside 2-100 characters), wrong_type or unknown_field (with allowed_fields).
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 403 The credential belongs to no workspace (FORBIDDEN, workspace_required).
  • 429 Over the per-second window of the search bucket (RATE_LIMIT). Sent only where rate-limit enforcement is on; wait Retry-After seconds.
  • 500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.