Skip to content

Get Lead Finder List

Read one list with its item count.

GET/api/v1/lead-finder/lists/{list_id}

Requires an API key with the read scope.

Path Parameters#

list_idstringpathrequired
The list id.

Response#

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: read
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
404List not found: the list does not exist in this workspace

Rate Limit#

  • 300 requests per minute, shared by every read 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 (read).
  • 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