# List segments `GET /api/v1/segments` The store's named audiences, newest first. member_count IS AS STALE AS last_refreshed_at SAYS IT IS. A dynamic segment's size is whatever the last materialisation recorded, not a live count, so read the two together; a client that treats the number as "who matches right now" will report a figure the next refresh changes with nothing having gone wrong. ?kind and ?status narrow it, so "the audiences a campaign can target today" is one call rather than a client-side filter over every segment in the store. MEMBERSHIP IS NOT PUBLISHED. There is no route here that lists the contacts a segment resolves to: those are ids of real people and this API has no marketing-contact resource to resolve them against, so they would be unusable to you and readable by anyone holding read_segments. ## Query parameters - `kind` (static | dynamic) — 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. - `status` (active | archived) — 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. - `limit` (integer) — 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. - `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. ## Responses - `200` — Success - `400` — The request was refused before any state changed. `code` is one of: `invalid_body`, a write body this route will not take. `reason` partitions it and `field` names the key when one key is at fault. `invalid_query`, a query parameter, including limit and after. `invalid_text`, a NUL byte or bytes that are not valid UTF-8 anywhere in the path, the query or the body. Strip control characters before sending. `idempotency_key_required`, a write sent without the Idempotency-Key header. `invalid_request`, an Idempotency-Key longer than 255 bytes. Routes add their own codes for rules only they know. Switch with a default arm. - `401` — No credential, or one this API does not accept. `code` is always `unauthorized`. THE BODY IS DELIBERATELY UNINFORMATIVE. An expired key, a revoked key, a publishable key, a key belonging to another merchant and a key that never existed are all refused with the same bytes, so this response cannot be used to probe which keys exist. Check the key's state in the dashboard rather than inferring it here. Send the key as `Authorization: Bearer ` or as `X-API-Key: `. It is never accepted in a query string. - `403` — The key lacks the read_segments scope. `code` is `insufficient_scope` and the message names the scope to ask the merchant for. - `429` — Too many requests. `code` is `rate_limited`. Two limits apply independently: one on the credential and the route family, one on the client address. The headers describe whichever has less left, so honouring Retry-After always clears the window that bound. - `default` — Any status this operation does not list, in the same envelope. A 5xx means the request may or may not have applied. Retry it with the SAME Idempotency-Key: that is the only way to find out without risking a duplicate, and it is what the key is for. A few 4xx conditions arrive here rather than as a listed status because they depend on the merchant's plan or on a module being wired: 402 when a quota or a plan limit is reached, and 503 when a capability the route needs is not configured on this deployment. Both carry a `code` naming which. ## Example ```bash curl --request GET \ --url 'https://api.mercemur.com/api/v1/segments' \ --header 'Authorization: Bearer ' ```