Custom fields
Workspace-defined fields on tasks — definitions, options and ordering.
Scopes: customfields:read, customfields:write
Custom fields let a workspace record things Krrim does not model natively — a customer account, an environment, a compliance flag. Definitions are managed here; values live on the task and are read and written through the task endpoints.
Read the definitions first
Field types, allowed options and which fields apply to which project are all workspace configuration. An integration that hard-codes an option value breaks the first time somebody renames it, so list the definitions and match on id:
GET /api/v1/custom-fields/Options
Select-style fields own their options, and options have their own endpoint because reordering and renaming one must not rewrite the values already recorded against it:
PUT /api/v1/custom-fields/options/{id}/
POST /api/v1/custom-fields/reorder/Reordering is presentation only. It changes the order options are offered in, never the value stored on any task.
Endpoints
| Method | Path | Scope |
|---|---|---|
GET | /api/v1/custom-fields/ | customfields:read |
POST | /api/v1/custom-fields/ | customfields:write |
PUT | /api/v1/custom-fields/options/{id}/ | customfields:write |
POST | /api/v1/custom-fields/reorder/ | customfields:write |
GET | /api/v1/custom-fields/{id}/ | customfields:read |
PUT | /api/v1/custom-fields/{id}/ | customfields:write |
DELETE | /api/v1/custom-fields/{id}/ | customfields:write |