Get a category
Header Parameters
Query Parameters
Comma-separated allow-list of top-level fields to return, e.g. ?fields=id,name. Narrows the response only; it cannot widen it, and ?expand= does nothing on this API.
Comma-separated list of top-level fields to leave out, e.g. ?omit=children.
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Row id. A row belonging to another company is 404 on every verb, never 403.
Response
The row. Soft-deleted rows are returned here too, with deleted set.
Response Attributes
Locale-keyed names, e.g. {"en": "Provisions", "de": "Verpflegung"}. The en value is what ?ordering=name sorts on, whatever language the key's user has.
Show child attributes
Parent category. Must belong to the same company, or 400.
Emoji shown next to the category in the UI.
Main general-ledger account (Sachkontennummer).
Further GL accounts. The main one stays in glAccount.
Show child attributes
eClass codes keyed by eClass version, e.g. {"5.1.4": ["39140100", "39140102"]}. Free-form JSON: Hivebuy does not validate its shape.
Show child attributes
Which budget a request in this category draws on: C company, D department, DO department only, P project, U user, NB no budget, CS supplier.
CDDOPUNBCSWhether the category is budgeted at all.
Whether a delivery has to be recorded before an invoice can be matched.
frame for framework agreements, material for goods.
framematerialChild categories, nested in full. Built from one flat per-company query, so the whole subtree is present, not just one level.
Show child attributes
When the row was created.
null on a live row; the timestamp of the soft delete otherwise. Read-only everywhere.
Missing, invalid, or expired API key, or a session credential was used instead of an API key.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.
Response Attributes
validationErrorclientErrorserverError Show child attributes
No such row for this company, including a row that belongs to another company, and a soft-deleted row you tried to write to. The API does not confirm whether the id exists elsewhere.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError