Models

UserGroupRead

object

typestringrequired

Immutable value

Example

user_groups

idstringrequired

Example

attributesUserGroupReadAttributesrequired

Show child attributes

created_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

updated_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

in_usebooleanread only

Is this user group ('financial administration') currently the active administration?

Example

false

can_see_membersbooleanread only

Can the current user see the members of this user group?

Example

true

titlestring

Title of the user group. By default, it is the same as the user's email address.

Example

demo@firefly

primary_currency_idstringread only

Returns the primary currency ID of the user group.

Example

primary_currency_codestring

Returns the primary currency code of the user group.

Example

EUR

primary_currency_symbolstringread only

Returns the primary currency symbol of the user group.

Example

primary_currency_decimal_placesinteger<int32>read only

Returns the primary currency decimal places of the user group.

Example

membersArray<UserGroupReadMembers>

Show child attributes

user_idstringread only

The ID of the member.

Example

user_emailstring<email>read only

The email address of the member

Example

james@firefly-iii.org

youbooleanread only

Is this you? (the current user)

Example

false

rolesArray<UserGroupReadRole>romng_trxmng_metaread_budgetsread_piggiesread_subscriptionsread_rulesread_recurringread_webhooksread_currenciesmng_budgetsmng_piggiesmng_subscriptionsmng_rulesmng_recurringmng_webhooksmng_currenciesview_reportsview_membershipsfullowner

linksObjectLinkrequired

Show child attributes

0object

Show child attributes

relstring

Example

self

uristring

Example

/OBJECTS/1

selfstring<uri>

Example

https://demo.firefly-iii.org/api/v1/OBJECTS/1

Example

{
  "type": "user_groups",
  "id": "2",
  "attributes": {
    "created_at": "2026-10-01T00:00:00+00:00",
    "updated_at": "2026-10-01T00:00:00+00:00",
    "in_use": false,
    "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",
        "you": false,
        "roles": [
          "ro"
        ]
      }
    ]
  },
  "links": {
    "0": {
      "rel": "self",
      "uri": "/OBJECTS/1"
    },
    "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
  }
}