---
title: "List instance users"
method: GET
path: "/admin/users"
tags: ["Admin"]
---

# List instance users

`GET /admin/users`

## Request

- Base URL: `https://cloud.kaneo.app/api`
- URL: `https://cloud.kaneo.app/api/admin/users`
- Auth: HTTP bearer

Page through every user account on this instance, optionally filtered by a case-insensitive name or email search. Requires an instance administrator session; API keys are rejected.

## Query parameters

- `search` string: Case-insensitive match against user name or email.
- `page` integer
- `limit` integer

## Response `200`

Users matching the search

- AdminUserList
  - `users` AdminUser[], required
    - `id` string, required
    - `name` string, required
    - `email` string, required
    - `emailVerified` boolean, required
    - `image` string, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `role` string, nullable, required
    - `banned` boolean, required
    - `banReason` string, nullable, required
    - `banExpires` string, date-time, nullable, required
  - `total` integer, required: Number of users matching the search, across all pages.

## Other responses

- `400`: Invalid search, page, or limit
- `401`: Missing or invalid credentials
- `403`: The caller is not an instance administrator or is authenticated with an API key
- `429`: The API key exceeded its rate limit or usage quota. Wait the number of seconds in Retry-After before retrying. The X-RateLimit headers are sent only when the rate limit was hit.

## Changes

- **2026-10-08** `c7b8a842601b`: 3 breaking, 4 info
  - removed the media type `text/plain` for the response with the status `400`
  - removed the media type `text/plain` for the response with the status `403`
  - removed the media type `text/plain` for the response with the status `429`
  - added the media type `application/json` for the response with the status `400`
  - …3 more
- **2026-10-08** `2ed51b8af657`: 3 breaking, 3 info
  - removed the media type `application/json` for the response with the status `400`
  - removed the media type `application/json` for the response with the status `401`
  - removed the media type `application/json` for the response with the status `403`
  - added the media type `text/plain` for the response with the status `400`
  - …2 more
- **2026-10-07** `df1439c724ee`: 2 breaking, 3 info
  - removed the media type `text/plain` for the response with the status `400`
  - removed the media type `text/plain` for the response with the status `403`
  - added the media type `application/json` for the response with the status `400`
  - added the media type `application/json` for the response with the status `401`
  - …1 more
- **2026-09-26** `25836704bfd0`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usekaneo/apis/kaneo-api/changes/admin/users/get.md)

---

[API](https://skmtc.dev/usekaneo/apis/kaneo-api.md) - [All operations](https://skmtc.dev/usekaneo/apis/kaneo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usekaneo/apis/kaneo-api/revisions/93f78789100c?raw)