Search users

GET

https://app.unleash-instance.example.com/api/admin/user-admin/search

GET

/api/admin/user-admin/search

$ curl https://app.unleash-instance.example.com/api/admin/user-admin/search \
>      -H "Authorization: <apiKey>"

1 [
2   {
3     "id": 123,
4     "name": "User",
5     "email": "user@example.com",
6     "username": "hunter",
7     "imageUrl": "https://example.com/242x200.png",
8     "inviteLink": "http://localhost:4242/invite-link/some-secret",
9     "loginAttempts": 3,
10     "emailSent": false,
11     "rootRole": 1,
12     "seenAt": "2023-06-30T11:42:00.345Z",
13     "createdAt": "2023-06-30T11:41:00.123Z",
14     "accountType": "User",
15     "permissions": [
16       "string"
17     ],
18     "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
19     "seatType": "Regular",
20     "companyRole": "Developer",
21     "productUpdatesEmailConsent": false,
22     "activeSessions": 2,
23     "deletedSessions": 1
24   }
25 ]

It will preform a simple search based on name and email matching the given query. Requires minimum 2 characters

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Query parameters

qstringOptional

The pattern to search in the username or email

Response

usersSearchSchema

Errors

401

Unauthorized Error