For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
13.5kProductPricingSign inStart free trialBook a demo
DocsAPIsSDKsEnterprise EdgeGuidesAcademyRelease notes
DocsAPIsSDKsEnterprise EdgeGuidesAcademyRelease notes
    • API overview
  • Client API
  • Frontend API
  • Admin API
      • GETRetrieves all licensed users data.
      • GETGet a list of groups
      • POSTCreate a new group
      • GETGet a single group
      • PUTUpdate a group
      • DELDelete a single group
      • DELDelete all SCIM groups
      • GETGet a list of roles
      • POSTCreate a new role
      • GETGet a single role
      • PUTUpdate a role
      • DELDelete a custom role
      • POSTValidate a role
      • GETGet all pending user access requests.
      • POSTApprove a user access request.
      • DELReject a user access request.
      • GETGet your own user details
      • GETGet your own user profile
      • POSTChange your own password
      • GETGet roles for currently logged in user
      • GETGets inactive users
      • POSTDeletes inactive users
      • POSTValidate password for a user
      • POSTChange password for a user
      • POSTReset user password
      • GETGet all users and [root roles](https://docs.getunleash.io/concepts/rbac#predefined-roles)
      • POSTCreate a new user
      • GETSearch users
      • GETGet basic user and group information
      • GETGet total count of admin accounts
      • GETGet user
      • PUTUpdate a user
      • DELDelete a user
      • DELDelete all SCIM users

Unleash reduces the risk of releasing new features, drives innovation by streamlining the software release process, and increases revenue by optimizing end-user experience. While we serve the needs of the world's largest, most security-conscious organizations, we are also rated the “Easiest Feature Management system to use” by G2.

GitHubGitHubLinkedInLinkedInX (Twitter)X (Twitter)SlackSlackStack OverflowStack OverflowYouTubeYouTube

Server SDKs

  • Node.js
  • Java
  • Go
  • Rust
  • Ruby
  • Python
  • .NET
  • PHP
  • All SDKs

Frontend SDKs

  • JavaScript
  • React
  • Next.js
  • Vue
  • iOS
  • Android
  • Flutter

Feature Flag use cases

  • Secure, scalable feature flags
  • Rollbacks
  • FedRAMP, SOC2, ISO2700 compliance
  • Progressive or gradual rollouts
  • Trunk-based development
  • Software kill switches
  • A/B testing
  • Feature management
  • Canary releases

Product

  • Quickstart
  • Unleash architecture
  • Pricing
  • Product vision
  • Open live demo
  • Open source
  • Enterprise feature management platform
  • Unleash vs LaunchDarkly

Support

  • Help center
  • Status
  • Changelog
Made in a cosy atmosphere in the Nordic countries.Copyright © 2026 Unleash
LogoLogo
13.5kProductPricingSign inStart free trialBook a demo
Admin APIUsers

Search users

||View as Markdown|
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
Was this page helpful?
Previous

Get basic user and group information

Next
Built with

Authentication

Authorizationstring
API key needed to access this API
OR
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
idinteger
The user id
namestring or null
Name of the user
emailstring
Email of the user
usernamestring or null
A unique username for the user
imageUrlstring
URL used for the user profile image
inviteLinkstring
If the user is actively inviting other users, this is the link that can be shared with other users
loginAttemptsinteger>=0
How many unsuccessful attempts at logging in has the user made
emailSentboolean
Is the welcome email sent to the user or not
rootRoleinteger>=0

Which root role this user is assigned

seenAtstring or nullformat: "date-time"
The last time this user logged in
createdAtstringformat: "date-time"
The user was created at this time
accountTypeenum
A user is either an actual User or a Service Account
Allowed values:
permissionslist of strings
Deprecated
scimIdstring or null
The SCIM ID of the user, only present if managed by SCIM
seatTypestring or null
The seat type of this user
companyRolestring or null
The role of the user within the company.
productUpdatesEmailConsentboolean or null
Whether the user has consented to receive product update emails.
activeSessionsinteger or null
Count of active browser sessions for this user
deletedSessionsdouble
Experimental. The number of deleted browser sessions after last login

Errors

401
Unauthorized Error