Dashboard
Segments

List segment members

GET
/api/v1/segments/{key}/members

Returns one page of the member list of a segment, oldest first, and the total number of matching members. Use limit and offset to page through the list.

Requires a management key.

Returns 404 if no segment has this key.

Authorization

bearer
headerAuthorizationBearer <token>

Send a credential in the Authorization header: Authorization: Bearer <token>. Each credential belongs to one environment of one workspace, so the API never takes a workspace or environment in the URL.

  • Management key (ffk_…, secret): manages flags, segments, environments, and API keys, and reads the audit log and analytics. It can also do everything an evaluation key can.
  • Evaluation key (ffk_…, secret): for server SDKs. It evaluates flags, reads flag definitions for local evaluation, and sends telemetry.
  • Public token (ffp_…, not secret): for browser and mobile apps. It evaluates flags through OFREP and sends telemetry. It cannot read flag definitions.

Keep secret keys on your server. A 401 response means the credential is missing or not valid. A 403 response means the credential is valid but its role cannot perform the operation.

Path Parameters

key*string

The segment key, such as beta-testers.

Query Parameters

query?string

Return only members whose key contains this text. The match ignores case.

limit?string

The maximum number of members to return, as a whole number. Defaults to 50. Values above 200 return 200 members.

offset?string

The number of members to skip, as a whole number. Defaults to 0.

Response Body

OK

application/json
  1. response

One page of a segment's member list.

members*array<>

The members on this page, oldest first.

total*number|
Example Request
curl -X GET 'https://api.toggld.io/api/v1/segments/string/members'
Example Response
{  "members": [    {      "key": "user-123",      "addedAt": "2026-05-02T10:00:00.000Z"    },    {      "key": "user-456",      "addedAt": "2026-05-02T10:00:00.000Z"    }  ],  "total": 2}