List categories

GET /api/v1/categories

List categories

cURL

curl --request GET \
  --url https://app.sure.am/api/v1/categories \
  --header 'X-Api-Key: <api-key>'

200

{
  "categories": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "classification": "income",
      "color": "<string>",
      "icon": "<string>",
      "subcategories_count": 1,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "parent": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "pagination": {
    "page": 2,
    "per_page": 2,
    "total_count": 1,
    "total_pages": 1
  }
}

Authorizations

X-Api-Key · string · header · required

API key for authentication. Generate one from your account settings.

Query Parameters

page · integer

Page number (default: 1)

per_page · integer

Items per page (default: 25, max: 100)

classification · enum<string>

Filter by classification (income or expense)

Available options: income, expense

roots_only · boolean

Return only root categories (no parent)

parent_id · string<uuid>

Filter by parent category ID

Response

200 - application/json

categories filtered by parent

categories · object[] · required

Show child attributes

pagination · object · required

Show child attributes