Skip to main content
GET
/
api
/
v1
/
categories
/
{id}
Get category
curl --request GET \
  --url https://breadbox.example.com/api/v1/categories/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "short_id": "<string>",
  "name": "<string>",
  "parent_id": "<string>",
  "kind": "<string>",
  "archived": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Path Parameters

id
string
required

UUID or 8-char short_id.

Response

Category.

id
string
short_id
string
name
string
parent_id
string | null
kind
string

income | expense | transfer.

archived
boolean
created_at
string<date-time>