LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Segments

Get big segment membership for user

GET
/api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users/{userKey}

Contexts are now available

After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Get expiring targets for segment instead of this endpoint. To learn more, read Contexts.

Get the membership status (included/excluded) for a given user in this big segment. This operation does not support standard segments.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string

The project key

Formatstring
environmentKey*string

The environment key

Formatstring
segmentKey*string

The segment key

Formatstring
userKey*string

The user key

Formatstring

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/segments/string/string/string/users/string"
{  "userKey": "string",  "included": true,  "excluded": true}

Update user context targets on a big segment POST

Update user context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments.

Get expiring targets for segment GET

Get a list of a segment's context targets that are scheduled for removal.