Skip to main content
GET
/
api
/
v2
/
segments
List segments
curl --request GET \
  --url https://api.example.com/api/v2/segments
Lists the segments (reusable filter sets) owned by the user. Code-side these are segments; user-facing we call them “segments”. To create a new segment, see POST /api/v2/segments. To author + attach to a stream in one shot, see POST /api/v2/streams (the pairs field accepts inline segment objects).

​
Query parameters

NameTypeDescription
excludeArchivedbooleanDefault true - hides archived segments

​
Response

{
  "segments": [
    {
      "id": 12,
      "userFacingId": "seg_12",
      "name": null,
      "description": "AI founders building developer tools",
      "genderValues": [],
      "appliedSearchFilters": { "job_role": ["Founder", "CEO"] },
      "followerCountTiers": [],
      "linkedStreamCount": 2,
      "createdAt": "2026-06-01T10:00:00Z",
      "updatedAt": "2026-06-01T10:00:00Z"
    }
  ]
}

​
Notes

Editing a segment’s filters in place is intentionally NOT exposed on the public API (mutating a segment affects classification across every stream that references it - too easy to get wrong from an integration). Workflow:
  1. POST /api/v2/segments to create a new segment with the desired filters
  2. PATCH /api/v2/streams/{id} to swap the affected streams’ pairs to use the new segment

​
Auth

Bearer or session cookie.