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

# List segments

`GET /v1/finder/segments`

## Request

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

The brand's smart segments. A **segment** is a saved filter over your saved prospects, so who is in it changes as they do. `count` and `with_email` are worked out when you ask.

**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`

Segments

- FinderSegmentPage
  - `data` FinderSegment[], required
    - `id` string, required: Prefixed id (`fseg_…`)
    - `object` 'finder_segment', required
    - `brand_id` string, required: Prefixed id (`fbr_…`)
    - `name` string, required
    - `colour` string, nullable, required: pink, sky, lilac, mint or coral
    - `filter` object, nullable, required: The saved filter, as the app stores it. Null when it no longer reads, and then the segment matches nobody.
    - `count` integer, required: Saved prospects in it now
    - `with_email` integer, required: How many of them have an email address
    - `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)