Penny Docs
Tags

Create Tag

POST
/v1/households/{household_id}/tags

Creates a household tag that can be attached to transactions alongside their category. Returns the new tag with a transaction count of zero.

The name must be unique among active household tags. Supply a color or use null for no custom color.

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
color?|null

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/tags" \  -H "Content-Type: application/json" \  -d '{    "name": "Work meals"  }'
{  "id": "Tg8qN1cK5rWd",  "name": "Work meals",  "color": "#6D5BD0",  "transaction_count": 12}

List Tags GET

Lists all active household tags with their colors and visible transaction counts. The response is not paginated and includes unused tags. Deleted tags are…

Get Tag GET

Retrieves an active household tag, including its color and visible transaction count. Returns tagnotfound if the tag is deleted or does not belong to this…