OverviewPlatformsAPI Reference
Segments

Get a segment

Returns one segment with its filter and how many people match it now.

GET
/v1/segments/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Path Parameters

id*string

The segment's id (seg_...).

Length1 <= length

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/segments/seg_abc123"
{  "id": "string",  "name": "string",  "description": "string",  "filter": {    "platforms": [      "bluesky"    ],    "tags": [      "string"    ],    "minFollowers": 0,    "maxFollowers": 0,    "minMentions": 1,    "minNegative": 1,    "intents": [      "string"    ],    "keywordKinds": [      "brand"    ],    "neverKeywordKinds": [      "brand"    ],    "notPlatforms": [      "bluesky"    ],    "notTags": [      "string"    ],    "notIntents": [      "string"    ],    "newSinceDays": 1,    "linkHosts": [      "string"    ],    "muted": true,    "stages": [      "not_contacted"    ],    "automated": true,    "ownerIds": [      "string"    ]  },  "count": 0,  "createdAt": "string",  "updatedAt": "string"}
Was this page helpful?

Delete a segment

Deletes the segment. The people in it are not changed.

List segments

Returns your saved segments with the current number of people in each, plus presets you can save as a start. Segments are counted on each read and never stored as lists. To see who is in one, send its id to GET /v1/people.