---
title: "Get a paginated list of all users"
method: GET
path: "/admin/users"
tags: ["Internal", "Admin"]
---

# Get a paginated list of all users

`GET /admin/users`

## Query parameters

- `offset` integer — The number of items to skip before starting to collect the result set
- `limit` integer — The numbers of items to return
- `search` string
- `status` 'all' | 'active' | 'bots'
- `sort` 'asc' | 'desc'

## Response `200`

A paginated list of users

- PaginatedUsers
  - `total` integer
  - `results` UserWithDisabledReason[]
    - `createdAt` string
    - `disabledAt` string
    - `nameChangedAt` string
    - `id` string
    - `displayName` string
    - `previousNames` string[]
    - `scopes` string[]
    - `authProviders` string[] — Friendly names of the external auth methods this user signed in with (e.g. IndieAuth, Fediverse, or a plugin slug). Absent for anonymous users.
    - `displayColor` integer
    - `isBot` boolean
    - `authenticated` boolean
    - `disabledReason` string — Reason provided when the user was disabled.

## Other responses

- `400` — Bad request
- `401` — Basic auth failure
- `default` — Unexpected error

## Changes

> 104 revisions in range; 39 could not be searched.

- **2021-09-23** `02fef72d775b` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/owncast/apis/owncast-apis/changes/admin/users/get.md)

---

[API](https://skmtc.dev/owncast/apis/owncast-apis.md) · [All operations](https://skmtc.dev/owncast/apis/owncast-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/owncast/owncast-apis/revisions/e2ce1f2fcdfa/schema)