Skip to main content

The Custom Field object

Custom Fields are created in boards. They are used to organize the cards in your board.

Attributes​

color
nullable string
Color of the custom field, in hexadecimal format (e.g., #FF00FF).
created_at
string
Time at which the custom field was created.
id
string
Unique identifier for the custom field.
name
string
Name of the custom field.
options
object
Options of the custom field.
options.values
array
The options for the list/multi_list custom field.
options.values.*.id
string
ID of the option.
options.values.*.color
string
Color of the option, in hexadecimal format (e.g., #FF00FF).
options.values.*.value
string
Value of the option.
options.number_format
enum
Number format of the custom field. One of plain, separated, percentage, currency.
options.currency
enum
Currency of the custom field.
show_icon
boolean
Whether to show the icon in the UI.
type
enum
Type of the custom field. One of text, number, list, multi_list, date, boolean, url, email, phone.
updated_at
string
Time at which the custom field was last updated.
visible_to_clients
boolean
Whether custom field is visible to clients.
The custom field object
{
  "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"
}