FIfirefly-iii
user_groups

List all the user groups available to this user.

List all the user groups available to this user. These are essentially the 'financial administrations' that Firefly III supports.

get/v1/user-groups

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/user-groups
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Query parameters

limitinteger
Example:10

Number of items per page. The default pagination is per 50 items.

pageinteger
Example:1

Page number. The default pagination is per 50 items.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

A list of user groups.

Example response

{
  "data": [
    {
      "type": "user_groups",
      "id": "2",
      "attributes": {
        "created_at": "2025-08-01T00:00:00+00:00",
        "updated_at": "2025-08-01T00:00:00+00:00",
        "can_see_members": true,
        "title": "demo@firefly",
        "primary_currency_id": "12",
        "primary_currency_code": "EUR",
        "primary_currency_symbol": "$",
        "primary_currency_decimal_places": 2,
        "members": [
          {
            "user_id": "5",
            "user_email": "james@firefly-iii.org"
          }
        ]
      },
      "links": {
        "0": {
          "rel": "self",
          "uri": "/OBJECTS/1"
        },
        "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 20,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  },
  "links": {
    "self": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=4",
    "first": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=1",
    "next": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=3",
    "prev": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=2",
    "last": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=12"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.