Skip to content

Create Lead Finder List

Create an empty people or company list.

POST/api/v1/lead-finder/lists

Requires an API key with the write scope.

A workspace can hold up to 200 lists, each with up to 5,000 items.

Body Parameters#

namestringbodyrequired
List name, 1 to 200 characters.
kindstringbodyrequired
people or companies.

Response#

Returns the list with a 201 status code.

dataobject
Show data
idstring
List identifier.
namestring
List name.
kindstring
people or companies.
itemCountinteger
Items in the list.
createdAtstring
ISO 8601 timestamp.
updatedAtstring
ISO 8601 timestamp.

Errors#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: write
404Lead Finder is not enabled while Lead Finder is switched off on this environment
503Lead Finder is not configured when it is enabled but has no data provider key
422name is empty, kind is not people or companies, or the workspace already has 200 lists

Rate Limit#

  • 120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Was this page helpful?
View as MarkdownLast updated November 4, 2026