---
title: "GET /users"
method: GET
path: "/users"
tags: ["users-permissions"]
---

# GET /users

`GET /users`

## Query parameters

- `fields` union
  - string
  - string[]
- `populate` union
  - '*'
  - string
  - string[]
  - object
- `sort` union
  - string
  - string[]
  - object
  - object[]
- `pagination` union
  - object
    - `withCount` boolean
    - `page` integer, required
    - `pageSize` integer, required
  - object
    - `withCount` boolean
    - `start` integer, required
    - `limit` integer, required
- `filters` object

## Response `200`

OK

- object[]
  - `id` number, required
  - `documentId` string, required
  - `username` string, required
  - `email` string, required
  - `provider` string, required
  - `confirmed` boolean, required
  - `blocked` boolean, required
  - `role` union
    - number
    - object
      - `id` number, required
      - `name` string, required
      - `description` string, nullable, required
      - `type` string, required
      - `createdAt` string, required
      - `updatedAt` string, required
  - `createdAt` string, required
  - `updatedAt` string, required
  - `publishedAt` string, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Internal server error

---

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