LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Users

Find users

Deprecated

GET
/api/v2/user-search/{projectKey}/{environmentKey}

Use contexts instead

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

Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query.

An example user attribute filter set is filter=firstName:Anna,activeTrial:false. This matches users that have the user attribute firstName set to Anna, that also have the attribute activeTrial set to false.

To paginate through results, follow the next link in the _links object. To learn more, read Representations.

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

Query Parameters

q?string

Full-text search for users based on name, first name, last name, e-mail address, or key

Formatstring
limit?integer

Specifies the maximum number of items in the collection to return (max: 50, default: 20)

Formatint64
searchAfter?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.

Formatstring
filter?string

A comma-separated list of user attribute filters. Each filter is in the form of attributeKey:attributeValue

Formatstring

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/user-search/string/string"
{  "_links": {    "next": {      "href": "/api/v2/user-search/my-project/my-environment?after=1647993600000&limit=20&searchAfter=my-user&sort=userKey",      "type": "application/json"    },    "self": {      "href": "/api/v2/user-search/my-project/my-environment?after=1647993600000&limit=20&sort=userKey",      "type": "application/json"    }  },  "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": "sandy@example.com",        "firstName": "Sandy",        "lastName": "Smith",        "avatar": "http://example.com/avatar.png",        "name": "Sandy Smith",        "anonymous": false,        "custom": {          "property1": null,          "property2": null        },        "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": {              "resources": [                "proj/*:env/*;qa_*:/flag/*"              ],              "notResources": [                "string"              ],              "actions": [                "*"              ],              "notActions": [                "string"              ],              "effect": "allow",              "role_name": "string"            }          }        ],        "allowed": [          {            "action": "string",            "reason": {              "resources": [                "proj/*:env/*;qa_*:/flag/*"              ],              "notResources": [                "string"              ],              "actions": [                "*"              ],              "notActions": [                "string"              ],              "effect": "allow",              "role_name": "string"            }          }        ]      }    }  ]}

Rank Streaming usage by project GET

Rank projects with usage in the requested range by successful Streaming transfers. Legacy rows are attributed through the account's complete current environment-to-project mapping. If any successful row remains unattributed after resolution, the operation returns `409` instead of a partial ranking. The result limit does not cap the account-wide project universe or environment mapping. This source-specific operation does not provide Combined or Warehouse ranking.

List users GET

> ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Search for contexts](https://launchdarkly.com/docs/api/contexts/search-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](https://launchdarkly.com/docs/api#representations).