List users — LaunchDarkly

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.

Path parameters

projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

Query parameters

limitlongOptional

The number of elements to return per page

searchAfterstringOptional

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

Users collection response

totalCountinteger

The total number of users in the environment

itemslist of objects

Details on the users

_linksmap from strings to objectsOptional

The location and content type of related resources

Errors

1 curl https://app.launchdarkly.com/api/v2/users/projectKey/environmentKey \ 2 -H "Authorization: <apiKey>"

1 { 2 "totalCount": 245, 3 "items": [ 4 { 5 "lastPing": "2022-06-28T23:21:29Z", 6 "environmentId": "environmentId", 7 "ownerId": "ownerId", 8 "user": { 9 "key": "user-key-123abc", 10 "secondary": "2398127", 11 "ip": "10.10.10.10", 12 "country": "United States", 13 "email": "sandy@example.com", 14 "firstName": "Sandy", 15 "lastName": "Smith", 16 "avatar": "http://example.com/avatar.png", 17 "name": "Sandy Smith", 18 "anonymous": false 19 }, 20 "sortValue": { 21 "key": "value" 22 }, 23 "_links": { 24 "parent": { 25 "href": "/api/v2/users/my-project/my-environment", 26 "type": "application/json" 27 }, 28 "self": { 29 "href": "/api/v2/users/my-project/my-environment/my-user", 30 "type": "application/json" 31 }, 32 "settings": { 33 "href": "/api/v2/users/my-project/my-environment/my-user/flags", 34 "type": "text/html" 35 }, 36 "site": { 37 "href": "/my-project/my-environment/users/my-user", 38 "type": "text/html" 39 } 40 }, 41 "_access": { 42 "denied": [ 43 { 44 "action": "action", 45 "reason": { 46 "effect": "allow" 47 } 48 } 49 ], 50 "allowed": [ 51 { 52 "action": "action", 53 "reason": { 54 "effect": "allow" 55 } 56 } 57 ] 58 } 59 } 60 ], 61 "_links": { 62 "next": { 63 "href": "/api/v2/users/my-project/my-environment?after=1647993600000&limit=20&searchAfter=my-user", 64 "type": "application/json" 65 }, 66 "self": { 67 "href": "/api/v2/users/my-project/my-environment?after=1647993600000&limit=20", 68 "type": "application/json" 69 } 70 } 71 }

1	curl https://app.launchdarkly.com/api/v2/users/projectKey/environmentKey \
2	-H "Authorization: <apiKey>"

1	{
2	"totalCount": 245,
3	"items": [
4	{
5	"lastPing": "2022-06-28T23:21:29Z",
6	"environmentId": "environmentId",
7	"ownerId": "ownerId",
8	"user": {
9	"key": "user-key-123abc",
10	"secondary": "2398127",
11	"ip": "10.10.10.10",
12	"country": "United States",
13	"email": "sandy@example.com",
14	"firstName": "Sandy",
15	"lastName": "Smith",
16	"avatar": "http://example.com/avatar.png",
17	"name": "Sandy Smith",
18	"anonymous": false
19	},
20	"sortValue": {
21	"key": "value"
22	},
23	"_links": {
24	"parent": {
25	"href": "/api/v2/users/my-project/my-environment",
26	"type": "application/json"
27	},
28	"self": {
29	"href": "/api/v2/users/my-project/my-environment/my-user",
30	"type": "application/json"
31	},
32	"settings": {
33	"href": "/api/v2/users/my-project/my-environment/my-user/flags",
34	"type": "text/html"
35	},
36	"site": {
37	"href": "/my-project/my-environment/users/my-user",
38	"type": "text/html"
39	}
40	},
41	"_access": {
42	"denied": [
43	{
44	"action": "action",
45	"reason": {
46	"effect": "allow"
47	}
48	}
49	],
50	"allowed": [
51	{
52	"action": "action",
53	"reason": {
54	"effect": "allow"
55	}
56	}
57	]
58	}
59	}
60	],
61	"_links": {
62	"next": {
63	"href": "/api/v2/users/my-project/my-environment?after=1647993600000&limit=20&searchAfter=my-user",
64	"type": "application/json"
65	},
66	"self": {
67	"href": "/api/v2/users/my-project/my-environment?after=1647993600000&limit=20",
68	"type": "application/json"
69	}
70	}
71	}