---
title: "Search users"
method: GET
path: "/api/admin/user-admin/search"
tags: ["Users"]
---

# Search users

`GET /api/admin/user-admin/search`

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

## Query parameters

- `q` string

## Response `200`

usersSearchSchema

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

## Other responses

- `401` — Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.

---

[API](https://skmtc.net/unleash/apis/unleash-api-3.md) · [All operations](https://skmtc.net/unleash/apis/unleash-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unleash/unleash-api-3/versions/b2c3116e633e/schema)