segments
List the current members of a Segment
GET /v1/segments/{id}/members
Auth required
api.segments.view
Returns one page of a Segment's current members (contact id + email),
derived from the membership transition log. 404 not_found when the
Segment does not exist. Member emails are returned in full —
api.segments.view is the PII gate.
Path parameters
id string required The Segment's UUID or, when the value does not parse as a UUID, its org-unique key. Unknown handles read as 404 not_found. Accepted on every Segment route, read and write alike.
Query parameters
limit integer optional Page size (1–200). Default 50.
cursor string optional Opaque cursor returned from the previous page.
Responses
Errors follow the RFC 7807 problem format — see the error reference.
200 Cursor-paginated list of members application/json
data array<object> required Each entry in data:
contact_id string<uuid> required email string<email> required entered_at string<date-time> required When the contact most recently entered the Segment.
pagination object required Fields of pagination:
has_more boolean required next_cursor string | null optional 401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
422 A query parameter, path value or body field failed validation.
The body is a
validation_failed Problem. When the refusal is about a
reference — a segment key, template slug, topic or attribute name the
organization does not have — it additionally carries validation_code,
field, line/column, missing, candidates and next_step, so a
client can correct the call without a second round of guessing. See
ValidationProblem.
application/problem+json 429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The
code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json