---
title: "List all the user groups available to this user."
method: GET
path: "/v1/user-groups"
tags: ["user_groups"]
---

# List all the user groups available to this user.

`GET /v1/user-groups`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/user-groups`
- 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 user groups available to this user. These are essentially the 'financial administrations' that Firefly III supports.

## Query parameters

- `limit` integer
- `page` integer

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

A list of user groups.

- UserGroupArray
  - `data` UserGroupRead[], required
    - `type` string, string, required: Immutable value
    - `id` string, string, required
    - `attributes` UserGroupReadAttributes, required
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `in_use` boolean: Is this user group ('financial administration') currently the active administration?
      - `can_see_members` boolean: Can the current user see the members of this user group?
      - `title` string, string: Title of the user group. By default, it is the same as the user's email address.
      - `primary_currency_id` string, string: Returns the primary currency ID of the user group.
      - `primary_currency_code` string, string: Returns the primary currency code of the user group.
      - `primary_currency_symbol` string, string: Returns the primary currency symbol of the user group.
      - `primary_currency_decimal_places` integer: Returns the primary currency decimal places of the user group.
      - `members` UserGroupReadMembers[]
        - `user_id` string, string: The ID of the member.
        - `user_email` string, email: The email address of the member
        - `you` boolean: Is this you? (the current user)
        - `roles` UserGroupReadRole[]
    - `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-16.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-16/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-16/revisions/9935effbe852?raw)