---
title: "Get users"
method: GET
path: "/api/v1/users"
tags: ["Users"]
---

# Get users

`GET /api/v1/users`

## Request

- Base URL: `https://api.atono.io`
- URL: `https://api.atono.io/api/v1/users`
- Auth: API key in header `X-API-KEY`

## Query parameters

- `filter[withDeleted]` boolean, nullable: When true, deleted users are included in the response. Defaults to false.
- `page[number]` integer, nullable: Returns a specific page of results, starting from page `0`. Use with `page[size]` to control how many items are returned per page. For example, if `page[size]` is `20`, then `page[number]=2` returns items 21-40.
- `page[size]` integer, nullable: Controls how many items are returned in each response page.
- `page[offset]` integer, nullable: Skips the specified number of items before starting the result set. For example, if `page[offset]` is `30` and `page[size]` is `10`, the response returns items 31-40.
- `sort` string[], nullable

## Response `200`

Successfully retrieved the list of users and their included relationships.

- MultiResourceBodyUserResourceV1
  - `data` UserResourceV1[]: A list of returned resources, based on the request.
    - `type` string: Identifies the type of resource.
    - `id` string, uuid: The unique identifier for the resource, typically a UUID.
    - `attributes` UserResourceV1Attributes: Contains the structured data fields that describe the resource, such as properties, settings, and timestamps.
      - `createdAt` string, date-time: The date and time the user account was created.
      - `updatedAt` string, date-time: The date and time the user’s information (e.g., name, status, or roles) was last updated.
      - `invitedAt` string, date-time: The date and time the user was sent an invitation to join the workspace.
      - `email` string, email: The user’s email address. Must be unique across all users.
      - `fullName` string, nullable: The user’s full name, stored as a single field.
      - `deleted` boolean: Indicates whether the user has been deleted.
  - `errors` ProblemDetail[]: A list of errors returned with the response, if the request could not be completed. Each object includes details about a specific issue.
    - `id` string: A unique identifier for this specific error occurrence. Useful for debugging and support.
    - `links` object, nullable: Links related to the error. May include a URL to relevant documentation or support resources.
    - `status` integer: The HTTP status code associated with the error (e.g., 400, 404, 422).
    - `code` string: An internal code that identifies the type or category of the error.
    - `title` string: A short summary of the problem.
    - `source` ProblemSource: Identifies the part of the request that caused the error. Only one source is present per error.
      - `pointer` string, nullable: Specifies the path to the field in the request body that caused the error.
      - `parameter` string, nullable: Identifies a query parameter in the request URL that caused the error.
      - `header` string, nullable: Identifies the request header that caused the error.
    - `detail` string: Additional information about the error, intended to provide more context than the title.
    - `meta` unknown
  - `meta` unknown
  - `included` unknown[]: A list of related resources included in the response, either automatically by the API or in response to an `include` parameter in the request. Each item contains a full resource object (e.g., users, teams, acceptance criteria).
    - unknown
  - `links` unknown

---

[API](https://skmtc.dev/atono/apis/backend-api.md) · [All operations](https://skmtc.dev/atono/apis/backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atono/apis/backend-api/revisions/78a57b1d8c3d?raw)