---
title: "Get categories"
method: GET
path: "/rest/categories"
tags: ["Aggregations"]
---

# Get categories

`GET /rest/categories`

Retrieve a list of categories associated to the transactions of this user. Each category entry also includes aggregated statistics of the referenced transactions like total amount, number of transactions, high and low values.

## Query parameters

- `period` string
- `sort` 'asc' | 'desc'
- `amount_gte` string
- `amount_lt` string

## Parameters

- `#/paths/~1catalog/get/parameters/0` — unresolved $ref
- `#/paths/~1rest~1timeline/get/parameters/4` — unresolved $ref
- `#/paths/~1rest~1timeline/get/parameters/5` — unresolved $ref
- `#/paths/~1rest~1timeline/get/parameters/3` — unresolved $ref
- `#/paths/~1rest~1timeline/get/parameters/0` — unresolved $ref
- `#/paths/~1rest~1timeline/get/parameters/1` — unresolved $ref

## Response `200`

Transaction aggregation.

- object[]
  - `id` integer, required — ID of the finX standard category.
  - `name` string, required — Category name. The language depends on `Accept-Language` HTTP header provided in the request. Default is German.
  - `transactions` object, required — Transaction statistics for this category in the requested period.
    - `href` string, uri, required — A link to the list of the transactions matching this category.
    - `count` integer, required — Number of transactions in this category.
    - `total` number, float, required — Total amount of transactions in this category.
    - `low` number, float, required — Highest expense for this category.
    - `high` number, float, required — Highest deposit for this category.
  - `children` object[] — List of child categories of this category
    - `id` Id — unresolved $ref
    - `name` Name — unresolved $ref
    - `transactions` Transactions — unresolved $ref

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref

---

[API](https://skmtc.net/qwist/apis/finx-api.md) · [All operations](https://skmtc.net/qwist/apis/finx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/qwist/finx-api/revisions/b75f5c1aa39e/schema)