GetLeads

View as Markdown
Get a paginated collection of the blacklisted leads 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 name, email, profile URL and LinkedIn member id. - **matchingStatus** _(optional)_: filter by how the entry resolved. One of: - `Matching` - still resolving: a URL awaiting enrichment, or an email awaiting reverse lookup. - `Matched` - resolved to a LinkedIn profile. Excludes that exact person. - `NotFound` - the URL or email resolved to nothing. Excludes nobody. - `BroadMatch` - a name-only entry. Nothing to resolve; excludes by exact name comparison. Each item also carries **resolutionStage** and **resolutionError**, a finer-grained diagnostic view of the same resolution - use them to tell an entry waiting on the email lookup from one whose profile enrichment failed. **resolutionStage** is one of `AwaitingProfileEnrichment`, `ProfileEnrichmentNoData`, `ProfileEnrichmentFailed`, `AwaitingReverseLookup`, `ReverseLookupNotEnabled`, `ReverseLookupNoProfile`, `NotResolvable` or `Resolved`. A name-only entry goes straight to `NotResolvable`. An email-only entry goes to `AwaitingReverseLookup` when the workspace has reverse lookup enabled and `ReverseLookupNotEnabled` when it does not, settling on `Resolved` or `ReverseLookupNoProfile` once the lookup returns. **resolutionError** carries a human-readable reason when resolution failed, and is null otherwise. **matchingStatus** and **resolutionStage** are returned as strings.

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