Get flag setting for user

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Get a single flag setting for a user by flag key.

The _value is the flag variation that the user receives. The setting indicates whether you’ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be false. The example response indicates that the user Abbie_Braun has the sort.order flag enabled.

GET /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}

Get flag setting for user

cURL

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} \
  --header 'Authorization: <api-key>'

200

{
  "_links": {
    "sort.order": {
      "href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order",
      "type": "application/json"
    }
  },
  "_value": "true",
  "setting": "null",
  "reason": "{\"kind\": \"RULE_MATCH\"}"
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

environmentKey · string<string> · required

The environment key

userKey · string<string> · required

The user key

featureFlagKey · string<string> · required

The feature flag key

Response

200

application/json

User flag settings response

_links · object · required

The location and content type of related resources.

Show child attributes

Example:

{
  "sort.order": {
    "href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order",
    "type": "application/json"
  }
}

_value · any · required

The value of the flag variation that the user receives. If there is no defined default rule, this is null.

Example:

"true"

setting · any · required

Whether the user is explicitly targeted to receive a particular variation. The setting is false if you have turned off a feature flag for a user. It is null if you haven't assigned that user to a specific variation.

Example:

null

reason · object

Contains information about why that variation was selected.

Show child attributes

Example:

"{\"kind\": \"RULE_MATCH\"}"