Custom Properties API

Define custom fields (text, number, date, select, multi-select, checkbox, URL) on work items at the project level.

List Properties

GET /api/workspaces/{slug}/projects/{projectId}/custom-properties/

Create Property

POST /api/workspaces/{slug}/projects/{projectId}/custom-properties/

Request Body:

{
  "name": "Sprint Points",
  "description": "Story point estimate",
  "type": "number",
  "options": [],
  "is_required": false
}

Supported Types: text, number, date, select, multi_select, checkbox, url

For select and multi_select, provide options:

{
  "name": "Environment",
  "type": "select",
  "options": ["Production", "Staging", "Development"]
}

Update Property

PATCH /api/workspaces/{slug}/custom-properties/{propertyId}/

Delete Property

DELETE /api/workspaces/{slug}/custom-properties/{propertyId}/

Deleting a property also removes all values set on issues.

Get Issue Values

GET /api/workspaces/{slug}/projects/{projectId}/issues/{issueId}/custom-values/

Returns all custom property values for an issue.

Set Issue Value

PUT /api/workspaces/{slug}/issues/{issueId}/custom-values/{propertyId}/

Request Body:

{
  "value": 8
}

The value type depends on the property type:

• text, url: string
• number: number
• date: ISO 8601 string
• select: string (one of options)
• multi_select: array of strings
• checkbox: boolean