List users

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

Use contexts instead

After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Search for contexts instead of this endpoint.

List all users in the environment. Includes the total count of users. This is useful for exporting all users in the system for further analysis.

Each page displays users up to a set limit. The default is 20. To page through, follow the next link in the _links object. To learn more, read Representations.

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

List users

cURL

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

200

{
  "totalCount": 245,
  "items": [
    {
      "lastPing": "2022-06-28T23:21:29.176609596Z",
      "environmentId": "1234a56b7c89d012345e678f",
      "ownerId": "12ab3c45de678910abc12345",
      "user": {
        "key": "user-key-123abc",
        "secondary": "2398127",
        "ip": "10.10.10.10",
        "country": "United States",
        "email": "[e-mail]",
        "firstName": "Sandy",
        "lastName": "Smith",
        "avatar": "http://example.com/avatar.png",
        "name": "Sandy Smith",
        "anonymous": false,
        "custom": {},
        "privateAttrs": [
          "<string>"
        ]
      },
      "sortValue": "user-key-123abc",
      "_links": {
        "parent": {
          "href": "/api/v2/users/my-project/my-environment",
          "type": "application/json"
        },
        "self": {
          "href": "/api/v2/users/my-project/my-environment/my-user",
          "type": "application/json"
        },
        "settings": {
          "href": "/api/v2/users/my-project/my-environment/my-user/flags",
          "type": "text/html"
        },
        "site": {
          "href": "/my-project/my-environment/users/my-user",
          "type": "text/html"
        }
      },
      "_access": {
        "denied": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ],
        "allowed": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ]
      }
    }
  ],
  "_links": {
    "next": {
      "href": "/api/v2/users/my-project/my-environment?after=1647993600000&limit=20&searchAfter=my-user",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/users/my-project/my-environment?after=1647993600000&limit=20",
      "type": "application/json"
    }
  }
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

environmentKey · string<string> · required

The environment key

Query Parameters

limit · integer<int64>

The number of elements to return per page

searchAfter · string<string>

Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the next link we provide instead.

Response

200

application/json

Users collection response

totalCount · integer · required

The total number of users in the environment

Example:

245

items · object[] · required

Details on the users

Show child attributes

_links · object

The location and content type of related resources

Show child attributes

Example:

{
  "next": {
    "href": "/api/v2/users/my-project/my-environment?after=1647993600000&limit=20&searchAfter=my-user",
    "type": "application/json"
  },
  "self": {
    "href": "/api/v2/users/my-project/my-environment?after=1647993600000&limit=20",
    "type": "application/json"
  }
}