API Documentation
Custom Field Options ¶
Custom Field Options ¶
Custom field options define the choices available for custom fields with the select or multiple select data types.
Following diagram shows custom field options in our data hierarchy:
Supported filter params
-
custom_field_id
-
archived (‘true’ or ‘false’)
GET /api/v2/custom_field_options
Requests
GET /api/v2/custom_field_options
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "1",
"type": "custom_field_options",
"attributes": {
"name": "High",
"archived_at": null,
"position": 1,
"color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "266"
}
},
"custom_field": {
"meta": {
"included": false
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/custom_field_options?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/custom_field_options?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200
}
}
Get custom field optionsGET/api/v2/custom_field_options
GET /api/v2/custom_field_options/1
Requests
GET /api/v2/custom_field_options/2
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "2",
"type": "custom_field_options",
"attributes": {
"name": "High",
"archived_at": null,
"position": 1,
"color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "267"
}
},
"custom_field": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Gets a custom field optionGET/api/v2/custom_field_options/{id}
URI Parameters
- id
number
(required) Example: 1custom field option id
POST /api/v2/custom_field_options
Requests
POST /api/v2/custom_field_options
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "custom_field_options",
"attributes": {
"name": "High",
"custom_field_id": 3,
"color_id": 1,
"position": 1
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "4",
"type": "custom_field_options",
"attributes": {
"name": "High",
"archived_at": null,
"position": 1,
"color_id": "1"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "268"
}
},
"custom_field": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/custom_field_options
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "custom_field_options",
"attributes": {
"name": "High"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/custom_field"
}
}
]
}
Creates a custom field optionPOST/api/v2/custom_field_options
URI Parameters
- id
number
(required) Example: 1custom field option id
PATCH /api/v2/custom_field_options/1
Requests
PATCH /api/v2/custom_field_options/6
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "custom_field_options",
"attributes": {
"name": "Low"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "6",
"type": "custom_field_options",
"attributes": {
"name": "Low",
"archived_at": null,
"position": 1,
"color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "270"
}
},
"custom_field": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Updates a custom field optionPATCH/api/v2/custom_field_options/{id}
URI Parameters
- id
number
(required) Example: 1custom field option id
PATCH /api/v2/custom_field_options/1/archive
Requests
PATCH /api/v2/custom_field_options/7/archive
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "7",
"type": "custom_field_options",
"attributes": {
"name": "High",
"archived_at": "2025-07-24T06:04:48.000+02:00",
"position": 1,
"color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "271"
}
},
"custom_field": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Archives a custom field optionPATCH/api/v2/custom_field_options/{id}/archive
URI Parameters
- id
number
(required) Example: 1custom field option id
Generated by aglio on 24 Jul 2025