Get a category - ThinkOut Developers

GET

/

categories

/

{id}

Get a category

curl --request GET \
  --url https://api.thinkout.io/v1/categories/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.thinkout.io/v1/categories/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "category",
  "id": "3b4c5d6e-7f80-4a1b-9c2d-3e4f5a6b7c8d",
  "name": "Telecom",
  "code": null,
  "direction": "outflow",
  "activity": "operating",
  "parent_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "position": 2,
  "color": "#1b7fe4",
  "created_at": "2024-01-01T10:00:00Z",
  "updated_at": "2024-01-01T10:00:00Z"
}

{
  "error": {
    "type": "authentication",
    "code": "unauthorized",
    "message": "Invalid API key.",
    "param": null,
    "request_id": "req_01J8ZT4Q7Y6M3K"
  }
}

{
  "error": {
    "type": "not_found",
    "code": "resource_not_found",
    "message": "No transaction with id 8f1c0a4e-2b1d-4c8e-9f3a-7d6e5c4b3a21.",
    "param": "id",
    "request_id": "req_01J8ZT4Q7Y6M3K"
  }
}

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 this workspace was created from. null for a category someone created.

Only uncategorized_inflows and uncategorized_outflows are worth branching on. They mark the two categories holding unclassified money, they exist in every workspace, and ThinkOut refuses to delete them. Every other code depends on which template was used.

Example:

"uncategorized_outflows"

direction

enum<string>

required

Whether money comes in or goes out.

On a transaction or a forecast it follows the sign of amount and can never disagree with it. It is present so that responses can be grouped and read without inspecting signs.

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

⌘I

Get a category

curl --request GET \
  --url https://api.thinkout.io/v1/categories/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.thinkout.io/v1/categories/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "category",
  "id": "3b4c5d6e-7f80-4a1b-9c2d-3e4f5a6b7c8d",
  "name": "Telecom",
  "code": null,
  "direction": "outflow",
  "activity": "operating",
  "parent_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "position": 2,
  "color": "#1b7fe4",
  "created_at": "2024-01-01T10:00:00Z",
  "updated_at": "2024-01-01T10:00:00Z"
}

{
  "error": {
    "type": "authentication",
    "code": "unauthorized",
    "message": "Invalid API key.",
    "param": null,
    "request_id": "req_01J8ZT4Q7Y6M3K"
  }
}

{
  "error": {
    "type": "not_found",
    "code": "resource_not_found",
    "message": "No transaction with id 8f1c0a4e-2b1d-4c8e-9f3a-7d6e5c4b3a21.",
    "param": "id",
    "request_id": "req_01J8ZT4Q7Y6M3K"
  }
}