---
title: "List lists"
method: GET
path: "/v1/finder/lists"
tags: ["RecruitAffiliates.ai"]
---

# List lists

`GET /v1/finder/lists`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/finder/lists`
- Auth: HTTP bearer

The brand's lists, oldest first, each with how many saved prospects are on it.

**Scope:** `finder:read` (or `finder:write`)

## Query parameters

- `brand_id` string: Which brand. Defaults to the organization's oldest.
- `limit` string: 1 to 100, default 25
- `cursor` string: `next_cursor` from the previous page, with the same filters

## Response `200`

Lists

- FinderListPage
  - `data` FinderList[], required
    - `id` string, required: Prefixed id (`fls_…`)
    - `object` 'finder_list', required
    - `brand_id` string, required: Prefixed id (`fbr_…`)
    - `name` string, required
    - `colour` string, nullable, required
    - `count` integer, required: Saved, visible prospects on the list
    - `created_at` string, date-time, required: ISO-8601, UTC
  - `has_more` boolean, required: True when `next_cursor` fetches more
  - `total_count` integer, required: Every object matching the filters, ignoring the cursor
  - `next_cursor` string, nullable, required: Pass as `cursor` with the same filters to get the next page. Null on the last page.

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `402`: The organization's Recruit Affiliates plan does not include the API
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `409`: In conflict with the object's state, or the same idempotent request is still running
- `422`: The request was understood and refused
- `429`: Rate limited, by key or by organization: see Retry-After and X-RateLimit-Scope
- `501`: Not available to a test key (`sandbox_no_send`)

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)