---
title: "List users"
method: GET
path: "/api/v1/users"
tags: ["User"]
deprecated: true
---

# List users

`GET /api/v1/users`

> **Deprecated.**

Returns a collection with all users.

## Query parameters

- `filter` object
  - `ids` string[]
  - `username` string
  - `description` string
  - `color` string
  - `isActive` boolean
  - `email` string
- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.
- `order` object[]
  - `field` 'id' | 'username' | 'isActive' | 'createdAt'
  - `dir` 'asc' | 'desc'

## Response `200`

Operation completed successfully.

- object
  - `data` object[], required — A list of users
    - `id` string, required — Resource identifier.
    - `globalUserId` string, nullable — Nullable UUID identifier of the resource.
    - `username` string, required — The name of the user
    - `createdAt` string, date-time, required — The date the user was created
    - `description` string, nullable, required
    - `color` string, nullable — An optional hex value without the #, representing the avatar color
    - `isActive` boolean — A boolean value indicating if the user is active and can log in
    - `locale` string — A ISO-639-1 formatted string indicating the language the user will use
    - `isAdmin` boolean — A boolean value indicating if the user is an admin
    - `email` string, nullable
    - `emailVerifiedAt` string, date-time, nullable — The date where the user verified his email address
    - `mfa` boolean, nullable — Auth Platform MFA state
    - `contactId` string, nullable — The ID of the contact/address associated with this user
  - `extra` object, required
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages

## Other responses

- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)