RecruitAffiliates.ai

List segments

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)

get/v1/finder/segments

Request

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

Query parameters

brand_idstring

Which brand. Defaults to the organization's oldest.

Example:fbr_7uSyy9FqVLCFWrdPeZaK

limitstring

1 to 100, default 25

Example:25

cursorstring

next_cursor from the previous page, with the same filters

Response

Segments

has_moreboolean required

True when next_cursor fetches more

total_countinteger required

Every object matching the filters, ignoring the cursor

next_cursorstring nullable required

Pass as cursor with the same filters to get the next page. Null on the last page.

Example response

{
  "data": [
    {
      "id": "fseg_7uSyy9FqVLCFWrdPeZaK",
      "brand_id": "fbr_7uSyy9FqVLCFWrdPeZaK",
      "created_at": "2026-08-21T10:15:30.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.