---
title: "List all users"
method: GET
path: "/v1/users"
tags: ["Users"]
---

# List all users

`GET /v1/users`

Returns users in your Dotfile workspace. By default, only active users are returned. If you need suspended users, you can set the `include_suspended` query parameter to "true".

---

#### See also  
Learn more about [Filtering, Sorting and Pagination](./filtering-sorting-and-pagination)

## Query parameters

- `include_suspended` boolean
- `page` number
- `limit` number

## Response `200`

List of users in the workspace

**ℹ️ Click to see full payload**

- PaginatedUserList
  - `data` User[], required
    - `id` string, uuid, required
    - `first_name` string, required
    - `last_name` string, required
    - `email` string, email, required
    - `role` string, required — `owner` `admin` `member` `Custom Role name`
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `suspended_at` string, date-time, required — Suspension date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
  - `pagination` Pagination, required
    - `page` number, required — Current page number (defined in query parameter)
    - `limit` number, required — Item count per page (defined in query parameter)
    - `count` number, required — Total items count

## Other responses

- `400` — The request is either malformed or contain invalid parameters.

---

[API](https://skmtc.dev/dotfile/apis/api-specifications.md) · [All operations](https://skmtc.dev/dotfile/apis/api-specifications/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dotfile/api-specifications/revisions/36393567057b/schema)
