Penny Docs
Categories

Create Category Group

POST
/v1/households/{household_id}/category-groups

Creates a named category group for income, expense, or transfer categories and returns the new group.

The group name must be unique within the household. Assign categories to it using the category create or update endpoint; creating the group does not create categories.

Authorization

PersonalApiToken
AuthorizationBearer <token>

Use your personal API token (penny_pat_…) as the bearer credential. Enter the token only; the client adds the Bearer prefix. Read-only tokens permit read requests. Read/write tokens remain limited by your current household membership and role. See https://penny.finance/docs/api#authentication for setup.

In: header

Path Parameters

household_id*Household Id

Request Body

application/json

name*Name
Lengthlength <= 255
group_type*CategoryType

Value in

  • "income"
  • "transfer"
  • "expense"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/households/string/category-groups" \  -H "Content-Type: application/json" \  -d '{    "name": "Everyday Expenses",    "group_type": "income"  }'
{  "id": "Cg2mV7pL4zXe",  "name": "Everyday Expenses",  "group_type": "income"}

Update Category PUT

Replaces a category's name, emoji, type, and group assignment and returns the updated category. Supply the complete category definition. Set groupid to null…

Delete Category Group DELETE

Permanently deletes a category group and leaves its categories ungrouped. The categories, their types, and their transaction assignments are retained.…