Cloud

Trello / Reference / REST API

CustomFields

Operations

POST/customFields GET/customFields/{id}PUT/customFields/{id}DEL/customFields/{id}GET/customFields/{id}/options POST/customFields/{id}/options GET/customFields/{id}/options/{idCustomFieldOption}DEL/customFields/{id}/options/{idCustomFieldOption}

POST

Create a new Custom Field on a Board

Create a new Custom Field on a board.

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

idModel

TrelloID

Required

modelType

string

Required

name

string

Required

type

string

Required

options

string

pos

oneOf [string, number]

Required

display_cardFront

boolean

Responses

Success

application/json

CustomField

POST/customFields

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.trello.com/1/customFields?key=APIKey&token=APIToken' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "idModel": "5abbe4b7ddc1b351ef961414",
  "modelType": "board",
  "name": "<string>",
  "type": "checkbox",
  "options": "<string>",
  "pos": "top",
  "display_cardFront": true
}'

200Response

{
  "id": "5abbe4b7ddc1b351ef961414",
  "idModel": "586e8f681d4fe9b06a928307",
  "modelType": "board",
  "fieldGroup": "f6177ba6839d6fff0f73922c1cea105e793fda8a1433d466104dacc0b7c56955",
  "display": {
    "cardFront": true,
    "name": "Priority 🏔",
    "pos": "98304,",
    "options": [
      {
        "id": "5abbe4b7ddc1b351ef961414",
        "idCustomField": "5abbe4b7ddc1b351ef961414",
        "value": {
          "text": "High"
        },
        "color": "red",
        "pos": 16384
      }
    ]
  },
  "type": "list"
}

GET

Get a Custom Field

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

TrelloID

Required

Responses

Success

application/json

CustomField

GET/customFields/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/customFields/{id}?key=APIKey&token=APIToken' \
  --header 'Accept: application/json'

200Response

{
  "id": "5abbe4b7ddc1b351ef961414",
  "idModel": "586e8f681d4fe9b06a928307",
  "modelType": "board",
  "fieldGroup": "f6177ba6839d6fff0f73922c1cea105e793fda8a1433d466104dacc0b7c56955",
  "display": {
    "cardFront": true,
    "name": "Priority 🏔",
    "pos": "98304,",
    "options": [
      {
        "id": "5abbe4b7ddc1b351ef961414",
        "idCustomField": "5abbe4b7ddc1b351ef961414",
        "value": {
          "text": "High"
        },
        "color": "red",
        "pos": 16384
      }
    ]
  },
  "type": "list"
}

PUT

Update a Custom Field definition

Update a Custom Field definition.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

TrelloID

Required

Request bodyapplication/json

name

string

pos

oneOf [string, number]

display/cardFront

boolean

Responses

Success

application/json

CustomField

PUT/customFields/{id}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.trello.com/1/customFields/{id}?key=APIKey&token=APIToken' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "pos": "top",
  "display/cardFront": true
}'

200Response

{
  "id": "5abbe4b7ddc1b351ef961414",
  "idModel": "586e8f681d4fe9b06a928307",
  "modelType": "board",
  "fieldGroup": "f6177ba6839d6fff0f73922c1cea105e793fda8a1433d466104dacc0b7c56955",
  "display": {
    "cardFront": true,
    "name": "Priority 🏔",
    "pos": "98304,",
    "options": [
      {
        "id": "5abbe4b7ddc1b351ef961414",
        "idCustomField": "5abbe4b7ddc1b351ef961414",
        "value": {
          "text": "High"
        },
        "color": "red",
        "pos": 16384
      }
    ]
  },
  "type": "list"
}

DEL

Delete a Custom Field definition

Delete a Custom Field from a board.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

TrelloID

Required

Responses

Success

DEL/customFields/{id}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.trello.com/1/customFields/{id}?key=APIKey&token=APIToken'

GET

Get Options of Custom Field drop down

Get the options of a drop down Custom Field

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

TrelloID

Required

Responses

Success

GET/customFields/{id}/options

curl

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://api.trello.com/1/customFields/{id}/options?key=APIKey&token=APIToken'

POST

Add Option to Custom Field dropdown

Add an option to a dropdown Custom Field

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

TrelloID

Required

Responses

Success

POST/customFields/{id}/options

curl

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'https://api.trello.com/1/customFields/{id}/options?key=APIKey&token=APIToken'

GET

Get Option of Custom Field dropdown

Retrieve a specific, existing Option on a given dropdown-type Custom Field

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

TrelloID

Required

idCustomFieldOption

TrelloID

Required

Responses

Success

GET/customFields/{id}/options/{idCustomFieldOption}

curl

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://api.trello.com/1/customFields/{id}/options/{idCustomFieldOption}?key=APIKey&token=APIToken'

DEL

Delete Option of Custom Field dropdown

Delete an option from a Custom Field dropdown.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

TrelloID

Required

idCustomFieldOption

TrelloID

Required

Responses

Success

DEL/customFields/{id}/options/{idCustomFieldOption}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.trello.com/1/customFields/{id}/options/{idCustomFieldOption}?key=APIKey&token=APIToken'