Skip to main content
GET
Returns all lists for the API-key’s organization. The Gateway calls its default-list synchronizer before reading, so generated origin/Target lists and their current member counts can be materialized or refreshed as part of this request. A list id is a UUID; other list routes also accept a case-insensitive list name. This endpoint has no query parameters and is not paginated. It returns every list in data, ordered with default lists first and then by the Gateway’s stable default-list ordering. meta.next is never returned.
No limit parameter is supported. The endpoint returns all lists.

Response schema

data is an array of list objects: meta.count is the number of objects in data. There is no cursor, offset, page size, or next URL.

Errors and recovery

  • 400 (invalid_request): when using the platform API key, provide a valid X-FreshTalent-Org-Id UUID.
  • 401 (unauthorized): provide a valid Authorization: Bearer ... API key.
  • 402 (payment_required): the organization’s trial or paid access is locked; restore entitlement and retry.
  • 429: respect the rate limit and retry with backoff.
  • 500 or another 5xx: the read may have failed while default lists were being synchronized; retry with backoff, then reconcile with a fresh GET /lists.
A successful 200 is safe to retry. Because this read can refresh generated lists, a caller should not treat the request as a completely side-effect-free database read. Next: Create list or Get list.