GET
List segments

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

kind
enum<string>

Filter by how membership is decided. A dynamic segment selects its members from a rule; a static one holds a hand-curated list. This API creates dynamic segments only, so kind=dynamic is the set it can also edit.

Available options:
static,
dynamic
status
enum<string>

Filter by whether the segment is still maintained. Only an ACTIVE segment is picked up by the refresh sweeper, so status=active is the set whose member_count is being kept current.

Available options:
active,
archived
updated_after
string<date-time>

Segments touched at or after this RFC3339 instant. A SEGMENT MOVES WITHOUT ANYONE EDITING IT: member_count and last_refreshed_at are rewritten by every refresh, and a dynamic segment refreshes on its own schedule, so on the default created_at ordering a recomputation is invisible and a cached audience keeps targeting a membership that has already changed. Supplying it CHANGES THE ORDER of this endpoint: the default walk descends created_at, and this one climbs updated_at, which is the only ordering in which a keyset walk over a mutable column cannot skip a row. A segment refreshed mid-walk moves forward past your position and is returned again, so the walk is AT LEAST ONCE. The bound is INCLUSIVE, which matters here because a scheduled sweep touches many segments at nearly the same instant. A cursor belongs to ONE ordering and is refused by the other.

limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object