Skip to main content
GET
Get a category

Authorizations

Authorization
string
header
required

A workspace API key created in ThinkOut settings. One key reads one workspace.

Path Parameters

id
string<uuid>
required

Response

The category.

object
string
required
Allowed value: "category"
id
string<uuid>
required
name
string
required
Example:

"Telecom"

code
string | null
required

The category's identifier in the template the workspace was created from, or null for a category someone created. Only uncategorized_inflows and uncategorized_outflows exist in every workspace and are worth branching on.

Example:

"uncategorized_outflows"

direction
enum<string>
required

Whether money comes in or goes out. On a transaction or forecast it follows the sign of amount.

Available options:
inflow,
outflow
activity
enum<string>
required

Cash flow statement section the category belongs to.

Available options:
operating,
investing,
financing
parent_id
string<uuid> | null
required

null for top-level categories.

position
integer
required

Order among siblings, as shown in ThinkOut.

color
string | null
required

Lowercase hex color as shown in ThinkOut.

Pattern: ^#[0-9a-f]{6}$
Example:

"#1b7fe4"

created_at
string<date-time>
required
updated_at
string<date-time>
required