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

# List all users.

`GET /v1/users`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/users`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://demo.firefly-iii.org/oauth/authorize`
    - Token URL: `https://demo.firefly-iii.org/oauth/token`
  - HTTP bearer

List all the users in this instance of Firefly III.

## Query parameters

- `limit` integer
- `page` integer

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

A list of users.

- UserArray
  - `data` UserRead[], required
    - `type` string, string, required: Immutable value
    - `id` string, string, required
    - `attributes` User, required
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `email` string, email, required: The new users email address.
      - `blocked` boolean: Boolean to indicate if the user is blocked.
      - `blocked_code` 'email_changed' | 'null', string, nullable: If you say the user must be blocked, this will be the reason code.
      - `role` 'owner' | 'demo' | 'null', string, nullable: Role for the user. Can be empty or omitted.
    - `links` ObjectLink, required
      - `0` object
        - `rel` string, string
        - `uri` string, string
      - `self` string, uri
  - `meta` Meta, required
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer
  - `links` PageLink, required
    - `self` string, uri
    - `first` string, uri
    - `next` string, uri, nullable
    - `prev` string, uri, nullable
    - `last` string, uri

## Other responses

- `400`: Bad request
- `401`: Unauthenticated
- `404`: Page not found
- `500`: Internal exception

---

[API](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-17.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-17/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-17/revisions/ea021802490b?raw)