List a board's custom field definitions

GET

/boards/{board}/custom-fields/definitions

const url = 'https://projects.work.optidata.cloud/api/boards/1/custom-fields/definitions?include_inactive=false';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://projects.work.optidata.cloud/api/boards/1/custom-fields/definitions?include_inactive=false' \
  --header 'Authorization: Bearer <token>'

Returns the board’s active custom field definitions in display order. Pass include_inactive=1 to also return deactivated definitions.

Authorizations

bearerAuth

Parameters

Path Parameters

board

required

integer

Board id.

Query Parameters

include_inactive

boolean

Responses

200

Definitions.

application/json

Array<object>

Definition of a custom field. board_id null (and is_global true) means tenant-wide.

object

integer

board_id

integer | null

name

string

>= 1 characters <= 60 characters

type

string

Allowed values: text number select checkbox date person

description

string | null

<= 250 characters

config

Type-specific configuration. Examples — text: {multiline, max_length, placeholder, default_value}; select: {options: [{id, label, color}]}; checkbox: {default_value}.

object | null

order

integer

is_required

Required fields block card interactions (comments, files, timers) until filled.

boolean

is_active

boolean

is_global

boolean

created_at

string format: date-time

updated_at

string format: date-time

deleted_at

string | null format: date-time

Example

[
  {
    "type": "text"
  }
]

401

Missing, invalid or expired bearer passport.

application/json

object

error

string

Example

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

The authenticated user lacks the required board permission.

application/json

object

message

string

Example

{
  "message": "This action is unauthorized."
}

404

Resource not found, or a nested resource does not belong to its parent in the path.

application/json

object

message

string

Example

{
  "message": "Not found."
}