Skip to main content

Retrieve a custom field

Retrieves a custom field object.

Parameters​

No parameters.

Returns​

Returns the custom field object for a valid identifier.

get
/api/boards/{id}/custom-fields/{id}
curl https://{workspace}.kitchen.co/api/boards/{id}/custom-fields/{id} \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "id": "cf_b5fa830bd5d732626231ff89",
  "name": "Options",
  "type": "multi_list",
  "options": {
    "values": [
      {
        "id": "uL3haLfAeE258Lt6E8sjtyqg",
        "color": "#fec30c",
        "value": "Design"
      },
      {
        "id": "XN8Lb7veiE6w7qrEFuHMstnS",
        "color": "#8b7252",
        "value": "Development"
      }
    ],
    "number_format": null,
    "currency": null
  },
  "visible_to_clients": false,
  "show_icon": true,
  "color": null,
  "created_at": "2025-06-16T11:58:26+00:00",
  "updated_at": "2025-06-16T11:58:31+00:00"
}