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

# ListUsers

`GET /api/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
    - `phone` 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' | 'MEMBER' — Valid Values for Team Roles.
      - `teamId` string, uuid, required
      - `teamName` string, required
    - `username` string, nullable
  - `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.dev/litestar-org/apis/litestar-fullstack-template.md) · [All operations](https://skmtc.dev/litestar-org/apis/litestar-fullstack-template/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/litestar-org/litestar-fullstack-template/revisions/e5e7606282ec/schema)