Skip to main content
Every budget in Kualia lives in a workspace. Almost all endpoints are scoped to one: /v1/workspaces/{workspace_id}/.... Start here to find your workspace ids.

​
Get the authenticated user

GET /v1/user

curl https://api.kualia.com/v1/user \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "data": {
    "user": {
      "id": "user_2ab...",
      "email": "you@example.com",
      "name": "Igor",
      "default_workspace_id": "k1234..."
    }
  }
}

​
List workspaces

GET /v1/workspaces

{
  "data": {
    "workspaces": [
      {
        "id": "k1234...",
        "name": "Family Budget",
        "currency": "USD",
        "timezone": "America/New_York",
        "role": "admin",
        "archived": false
      }
    ]
  }
}
role is admin for workspaces you own (or family groups you manage) and member otherwise.

​
Get a workspace

GET /v1/workspaces/{workspace_id}
Returns the same fields plus ready_to_assign — the amount of money not yet assigned to any category: 
{
  "data": {
    "workspace": {
      "id": "k1234...",
      "name": "Family Budget",
      "currency": "USD",
      "timezone": "America/New_York",
      "role": "admin",
      "archived": false,
      "ready_to_assign": "412.50"
    }
  }
}
Archived workspaces are listed by GET /v1/workspaces but reject all other API calls with 403.