Skip to content

List all categories

GET
/categories
curl --request GET \
--url 'http://localhost:8000/api/v1/categories?type=income&limit=20' \
--header 'Authorization: Bearer <token>'
type
required
string
Allowed values: income expense

Type of the category (income or expense)

limit
integer
default: 20

Number of items to return per page

synced_since
string format: date-time

Get recent changes after this date

no_client_id
boolean

Get results with no client id

Successful operation

Media type application/json
object
last_sync
string format: date-time
data
Array<object>
object
id

ID of the category

integer
name

Name of the category

string
description

Description of the category

string
type

Type of the category (income or expense)

string
icon

Category icon

object
id

ID of the icon

integer
path

Image of the icon

string
type

Type of icon( image or icon or emoji)

string
sync_state

Sync state

object
id

ID of the sync state

integer
syncable_id

ID of the syncable

integer
client_generated_id

ID from the client

integer
syncable_type

Syncable type

string
source
string
last_synced_at

Date last synced

string format: date-time
created_at

Date created

string format: date-time
deleted_at

Date deleted

string format: date-time
Example generated
{
"last_sync": "2026-04-15T12:00:00Z",
"data": [
{
"id": 1,
"name": "example",
"description": "example",
"type": "example",
"icon": {
"id": 1,
"path": "example",
"type": "example"
},
"sync_state": {
"id": 1,
"syncable_id": 1,
"client_generated_id": 1,
"syncable_type": "example",
"source": "example",
"last_synced_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"deleted_at": "2026-04-15T12:00:00Z"
}
}
]
}

Internal server error