Skip to content
Klaarin
Open Klaarin

Lookups

Small, read-only reference collections for populating a task or project create form — statuses, job-role categories, output types, the workspace roster, and teams. Read-only: authoring these lists stays a Klaarin admin/web-app concern.

GET

/task-statuses

Lists the board's task statuses, in board order. Platform-wide — not scoped to a workspace.

Query parameters

  • includeInactivebooleanoptionaltrue to include inactive statuses (active-only by default)
  • limitintegeroptionalPage size, default 25, max 100
  • offsetintegeroptionalNumber of results to skip, default 0
GET

/task-statuses/{id}

Gets one task status.

GET

/project-statuses

Lists project statuses, in board order. Platform-wide — not scoped to a workspace.

Query parameters

  • includeInactivebooleanoptionaltrue to include inactive statuses (active-only by default)
  • limitintegeroptionalPage size, default 25, max 100
  • offsetintegeroptionalNumber of results to skip, default 0
GET

/project-statuses/{id}

Gets one project status.

GET

/task-categories

Lists the active workspace's task categories ("job roles" in the product UI).

Query parameters

  • limitintegeroptionalPage size, default 25, max 100
  • offsetintegeroptionalNumber of results to skip, default 0
GET

/task-categories/{id}

Gets one task category.

GET

/task-types

Lists the active workspace's task types ("outputs" in the product UI).

Query parameters

  • categoryIdintegeroptionalFilter to one category
  • limitintegeroptionalPage size, default 25, max 100
  • offsetintegeroptionalNumber of results to skip, default 0
GET

/task-types/{id}

Gets one task type.

GET

/users

Lists the active workspace's roster — use it to resolve assignee names to IDs.

Query parameters

  • limitintegeroptionalPage size, default 25, max 100
  • offsetintegeroptionalNumber of results to skip, default 0
GET

/users/{id}

Gets one user in the active workspace.

GET

/teams

Lists the active workspace's teams, each with its members and their team-specific role.

Query parameters

  • limitintegeroptionalPage size, default 25, max 100
  • offsetintegeroptionalNumber of results to skip, default 0
GET

/teams/{id}

Gets one team, with its members.

View example
List task statuses
curl https://api.klaarin.com/v1/task-statuses \
  -H "Authorization: Bearer kl_live_9f2ac…"
Response
{
  "data": [
    { "id": 1, "value": "todo", "label": "To do", "color": "#E0E0E0", "order": 0, "isDefault": true, "isCompleted": false },
    { "id": 5, "value": "completed", "label": "Completed", "color": "#4DAF4E", "order": 4, "isDefault": false, "isCompleted": true }
  ],
  "meta": { "total": 5, "limit": 25, "offset": 0, "hasMore": false }
}