---
title: "List Users"
method: GET
path: "/api/users"
tags: ["User Accounts"]
---

# List Users

`GET /api/users`

Retrieve the users.

## Query parameters

- `ids` string[], nullable
- `createdBefore` string, date-time, nullable
- `createdAfter` string, date-time, nullable
- `updatedBefore` string, date-time, nullable
- `updatedAfter` string, date-time, nullable
- `searchString` string, nullable
- `searchIgnoreCase` boolean, nullable
- `currentPage` integer
- `pageSize` integer
- `orderBy` string, nullable
- `sortOrder` 'asc' | 'desc' | 'null', nullable

## Response `200`

Request fulfilled, document follows

- object
  - `items` User[]
    - `avatarUrl` string, nullable
    - `email` string, required
    - `hasPassword` boolean
    - `id` string, uuid, required
    - `isActive` boolean
    - `isSuperuser` boolean
    - `isTwoFactorEnabled` boolean
    - `isVerified` boolean
    - `name` string, nullable
    - `oauthAccounts` OauthAccount[]
      - `accountEmail` string, required
      - `accountId` string, required
      - `id` string, uuid, required
      - `oauthName` string, required
      - `scopes` string[], nullable
    - `roles` UserRole[]
      - `assignedAt` string, date-time, required
      - `roleId` string, uuid, required
      - `roleName` string, required
      - `roleSlug` string, required
    - `teams` UserTeam[]
      - `isOwner` boolean
      - `role` 'admin' | 'editor' | 'member' — Valid values for team roles. Roles follow Jetstream conventions: - ADMIN: Full permissions (create, read, update, delete) - EDITOR: Limited permissions (read, create, update) - MEMBER: Basic read-only access Note: Team ownership is tracked separately via is_owner on TeamMember.
      - `teamId` string, uuid, required
      - `teamName` string, required
      - `teamSlug` string, required
  - `limit` integer — Maximal number of items to send.
  - `offset` integer — Offset from the beginning of the query.
  - `total` integer — Total number of items.

## Other responses

- `400` — Bad request syntax or unsupported method

---

[API](https://skmtc.net/litestar-org/apis/app.md) · [All operations](https://skmtc.net/litestar-org/apis/app/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/litestar-org/app/versions/461f3baecebb/schema)