groups

Create a new group

Creates a new expense group with the current user as admin

post/groups

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/groups
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

namestring required

Name of the group

descriptionstring

Description of the group

iconstring

Icon name for the group

colorstring

Hex color for the group

defaultCurrencystring

Default currency code (ISO 4217)

supportedCurrenciesstring[]

List of supported currencies

currencyOrderstring[]

Display order for currencies

Example request

{
  "name": "Weekend Trip",
  "description": "Trip expenses",
  "icon": "users",
  "color": "#3b82f6",
  "defaultCurrency": "USD",
  "supportedCurrencies": [
    "USD",
    "EUR"
  ],
  "currencyOrder": [
    "USD",
    "EUR"
  ]
}

Response

Group created successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Success"
}

Changes

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