API reference
6 operations in fields. Raw spec: openapi.json.
GET
/api/v1/boards/{id}/fieldsGET /api/boards/{id}/fields — active ticket definitions governing this board (org-wide plus board-owned), sort-order stable.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
POST
/api/v1/boards/{id}/fieldsPOST /api/boards/{id}/fields — creates a board-scoped definition (board-admin gated); emits `custom_field.def_created`.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Request body
CreateFieldDefRequest
Responses
| Status | Description |
|---|---|
200 | |
422 | invalid definition |
Security: bearer
PATCH
/api/v1/boards/{id}/fields/{field_id}PATCH /api/boards/{id}/fields/{field_id} — partial edit of a board-owned definition. Kind is immutable (it would orphan stored values); emit `custom_field.def_updated` on success.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | |
field_id | path | string | Yes |
Request body
UpdateFieldDefRequest
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
DELETE
/api/v1/boards/{id}/fields/{field_id}DELETE /api/boards/{id}/fields/{field_id} — removes the definition and cascades its stored values; emits `custom_field.def_removed`.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | |
field_id | path | string | Yes |
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
PUT
/api/v1/tickets/{id}/fields/{field_id}PUT /api/tickets/{id}/fields/{field_id} — validates the incoming JSON against the definition (kind coercion, option membership) and stores the canonical encoding; emits `ticket.field_set`.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | |
field_id | path | string | Yes |
Request body
SetTicketFieldValueRequest
Responses
| Status | Description |
|---|---|
200 | |
422 | value does not validate against the definition |
Security: bearer
DELETE
/api/v1/tickets/{id}/fields/{field_id}DELETE /api/tickets/{id}/fields/{field_id} — clears one value; refuses (422) to empty a REQUIRED definition; emits `ticket.field_cleared`.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | |
field_id | path | string | Yes |
Responses
| Status | Description |
|---|---|
200 | |
422 | field is required and cannot be emptied |
Security: bearer