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

# List all users in your account

`GET /v1/users`

List all users in your account

## Query parameters

- `search` string — Search users by this string
- `page` integer — Page of results to include (default = 1)
- `per_page` integer — How many results to include in each page (default = 10)
- `sort` 'first_name' | 'last_name' | 'email' — sort results by this property
- `direction` 'asc' | 'desc' | 'ASC' | 'DESC' — Direction to sort results in (asc = ascending, desc = descending)

## Response `200`

OK

- ListUsersResponse
  - `success` boolean — whether the request succeeded
  - `errors` string[]
  - `messages` string[], nullable
  - `metadata` object
    - `page` integer — Page number of the results
    - `page_size` integer — Number of results per page
    - `total` integer — Total number of results
    - `sort` string — Sorting criteria
    - `direction` 'asc' | 'desc' — Sorting direction
  - `result` User[]
    - `id` string, uuid — ID of the user
    - `firstname` string — User's first name / given name
    - `lastname` string — User's last name / family name / surname
    - `email` string — User's email address
    - `roles` UserRole[] — User's roles
    - `twofactor_enabled` boolean — If 2-factor authentication is enabled on this account
    - `twofactor_required` boolean — If 2-factor authentication is required to use this account
    - `status` 'active' | 'invited' — Status of the user

## Other responses

- `400` — Bad Request
- `401` — Authentication failed
- `403` — Not authorized to access endpoint
- `404` — User not found
- `405` — Invalid input
- `500` — Internal error

---

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