This endpoint returns a list of categories.

Log in to see full request history
Query Params
integer

Categories are paginated, this is the current page returned.

integer

Categories are paginated. By default, you get 20 by page. You can specify another number of categories by page.

string

Categories are sorted by descending id, by default. Use the attribute names separated by commas.

Sortable attributes are the following only: id, group_id, label, direction

string

You can choose to filter categories on a specific attributes (id, group_id, label, etc).

For instance, you can select the categories that have the direction cash_out by using the following filter: [{"field": "direction", "operator": "eq", "value": "cash_out"}].

Filterable attributes are the following only: id, group_id, label and direction.

Responses

Response body
object
integer
integer
integer
categories
array of objects
categories
object
integer
required

Category unique ID

string

Category unique UUID identifier

string

Group unique UUID identifier

integer

The corresponding identifier for the category group in the V2 API.
This field is provided to facilitate migration from V1 to V2 API by allowing mapping
between V1 and V2 identifiers. When transitioning to V2 endpoints, use this value
instead of the V1 id or source_id.

string

Category group name

string

Category name (is unique per group of categories)

string | null

cash_in cash_out

boolean
date-time

Category created date

date-time

Category created date

integer

The corresponding identifier for this resource in the V2 API.
This field is provided to facilitate migration from V1 to V2 API by allowing mapping
between V1 and V2 identifiers. When transitioning to V2 endpoints, use this value
instead of the V1 id or source_id.

Language
Credentials
OAuth2