List flag settings for user

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

Get the current flag settings for a given user.

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 and the alternate.page flag disabled, and that the user has not been explicitly targeted to receive a particular variation.

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

List flag settings for user

cURL

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

200

{
  "items": {
    "alternate.page": {
      "_links": {
        "self": {
          "href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/alternate.page",
          "type": "application/json"
        }
      },
      "_value": false,
      "setting": null
    },
    "sort.order": {
      "_links": {
        "self": {
          "href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order",
          "type": "application/json"
        }
      },
      "_value": true,
      "setting": null
    }
  },
  "_links": {
    "self": {
      "href": "/api/v2/users/lacuna/production/Abbie_Braun/flags",
      "type": "application/json"
    }
  }
}

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

Response

200

application/json

User flag settings collection response

items · object · required

An array of flag settings for the user

Show child attributes

Example:

{
  "alternate.page": {
    "_links": {
      "self": {
        "href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/alternate.page",
        "type": "application/json"
      }
    },
    "_value": false,
    "setting": null
  },
  "sort.order": {
    "_links": {
      "self": {
        "href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order",
        "type": "application/json"
      }
    },
    "_value": true,
    "setting": null
  }
}

_links · object · required

The location and content type of related resources

Show child attributes

Example:

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