Penny Docs
Tags

Get Tag

GET
/v1/households/{household_id}/tags/{tag_id}

Retrieves an active household tag, including its color and visible transaction count.

Returns tag_not_found if the tag is deleted or does not belong to this household.

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
tag_id*Tag Id

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/households/string/tags/string"
{  "id": "Tg8qN1cK5rWd",  "name": "Work meals",  "color": "#6D5BD0",  "transaction_count": 12}

Create Tag POST

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…

Delete Tag DELETE

Deletes a tag and removes it from every associated transaction, including transactions on deleted accounts. The transactions themselves are retained. Also…