> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getunleash.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getunleash.io/_mcp/server.

# Search users

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

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

Reference: https://docs.getunleash.io/api/search-users

## Authentication

- `Authorization` header (required) — API key needed to access this API
- `Authorization` header (bearer token, required) — API key needed to access this API, in Bearer token format

## Request

### Query parameters

- `q` (string, optional) — The pattern to search in the username or email

## Response

### 200

usersSearchSchema

- `list of object`
  - `id` (integer, required) — The user id
  - `name` (string, optional, nullable) — Name of the user
  - `email` (string, optional) — Email of the user
  - `username` (string, optional, nullable) — A unique username for the user
  - `imageUrl` (string, optional) — URL used for the user profile image
  - `inviteLink` (string, optional) — If the user is actively inviting other users, this is the link that can be shared with other users
  - `loginAttempts` (integer, optional) — How many unsuccessful attempts at logging in has the user made
  - `emailSent` (boolean, optional) — Is the welcome email sent to the user or not
  - `rootRole` (integer, optional) — Which [root role](https://docs.getunleash.io/concepts/rbac#predefined-roles) this user is assigned
  - `seenAt` (string, optional, nullable) — The last time this user logged in
  - `createdAt` (string, optional) — The user was created at this time
  - `accountType` (enum, optional) — A user is either an actual User or a Service Account
    - Allowed values: `User`, `Service Account`
  - `permissions` (list of string, optional) — Deprecated
  - `scimId` (string, optional, nullable) — The SCIM ID of the user, only present if managed by SCIM
  - `seatType` (string, optional, nullable) — The seat type of this user
  - `companyRole` (string, optional, nullable) — The role of the user within the company.
  - `productUpdatesEmailConsent` (boolean, optional, nullable) — Whether the user has consented to receive product update emails.
  - `activeSessions` (integer, optional, nullable) — Count of active browser sessions for this user
  - `deletedSessions` (double, optional) — Experimental. The number of deleted browser sessions after last login

## Examples

**Response**

```json
[
  {
    "id": 123,
    "name": "User",
    "email": "user@example.com",
    "username": "hunter",
    "imageUrl": "https://example.com/242x200.png",
    "inviteLink": "http://localhost:4242/invite-link/some-secret",
    "loginAttempts": 3,
    "emailSent": false,
    "rootRole": 1,
    "seenAt": "2023-06-30T11:42:00.345Z",
    "createdAt": "2023-06-30T11:41:00.123Z",
    "accountType": "User",
    "permissions": [
      "string"
    ],
    "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
    "seatType": "Regular",
    "companyRole": "Developer",
    "productUpdatesEmailConsent": false,
    "activeSessions": 2,
    "deletedSessions": 1
  }
]
```

**SDK Code**

```python
import requests

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

headers = {"Authorization": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.unleash-instance.example.com/api/admin/user-admin/search';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.unleash-instance.example.com/api/admin/user-admin/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.unleash-instance.example.com/api/admin/user-admin/search")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.unleash-instance.example.com/api/admin/user-admin/search', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.unleash-instance.example.com/api/admin/user-admin/search");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.unleash-instance.example.com/api/admin/user-admin/search")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```