Skip to navigation
HeyReach APIBlacklist

GetCompanies

View as Markdown

Get a paginated collection of the blacklisted companies in your workspace, newest first. The blacklist is workspace-scoped - each workspace keeps its own, and an API key only ever sees its own workspace’s entries.

  • offset (optional): the number of entries to skip. Defaults to 0.

  • limit (optional): the page size, between 1 and 100. Defaults to 10.

  • search (optional): a case-insensitive substring match on company name and company URL.

  • matchingStatus (optional): filter by how the entry resolved. One of:

    • Matching - still resolving: a company URL awaiting enrichment.

    • Matched - resolved to a LinkedIn company page. Excludes leads working at that company.

    • NotFound - the URL resolved to nothing. Excludes nobody.

    • BroadMatch - a name-only entry. Nothing to resolve; excludes by exact, case-insensitive company-name comparison.

matchingStatus is returned as a string.

Headers

X-API-KEYstringOptional

API key header using this scheme. Example: “X-API-KEY: {API_KEY}”

Request

This endpoint expects an object.
offsetintegerRequired
limitintegerRequired
searchstringRequired
matchingStatusstringRequired

Response

OK
totalCountstring
itemslist of objects