Skip to main content
GET
Returns one list and all of its memberships for the authenticated organization. The path value is trimmed and resolves either an exact UUID or a case-insensitive list name. If a name matches more than one list, the Gateway chooses the most recently updated match, so use the UUID for stable references.
string
required
List UUID or case-insensitive name. The value must not be empty. UUIDs are the stable choice when names can change or collide.
This endpoint has no pagination parameters. data.members contains every member, ordered by updated_at descending. There is no meta.next; for the members-only route, use GET /lists/:id/members, which likewise returns all members with meta.count.

Response schema

data contains the list fields plus members: Each member object is:

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 API key.
  • 402 (payment_required): restore the organization’s entitlement.
  • 404 (not_found): the UUID/name is not visible in this organization; check the identifier with List lists.
  • 429 or 5xx: retry with backoff. A successful read is safe to repeat.
:membershipId can be a membership UUID or a person slug when using the member routes. Next: Add list members.