The Trello REST API

CustomFields

Create a new Custom Field on a Board

POST /1/customFields

Create a new Custom Field on a board.

Request

Body parameters

idModel Required

string

Pattern: ^[0-9a-fA-F]{24}$

modelType Required

string

The type of model that the Custom Field is being defined on. This should always be board.

Valid values: board

name Required

string

The name of the Custom Field

type Required

string

The type of Custom Field to create.

Valid values: checkbox, list, number, text, date

options

string

If the type is checkbox

pos Required

oneOf [string, number]

display_cardFront

boolean

Whether this Custom Field should be shown on the front of Cards

Default: true

Example

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

Success

Content type	Value
application/json	CustomField

Get a Custom Field

GET /1/customFields/{id}

Request

Path parameters

id Required

string

ID of the Custom Field.

Pattern: ^[0-9a-fA-F]{24}$

Example

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'

Responses

200

Success

Content type	Value
application/json	CustomField

Update a Custom Field definition

PUT /1/customFields/{id}

Update a Custom Field definition.

Request

Path parameters

id Required

string

ID of the Custom Field.

Pattern: ^[0-9a-fA-F]{24}$

Body parameters

name

string

The name of the Custom Field

pos

oneOf [string, number]

display/cardFront

boolean

Whether to display this custom field on the front of cards

Example

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

Success

Content type	Value
application/json	CustomField

Delete a Custom Field definition

DELETE /1/customFields/{id}

Delete a Custom Field from a board.

Request

Path parameters

id Required

string

ID of the Custom Field.

Pattern: ^[0-9a-fA-F]{24}$

Example

cURL

Node.js

Java

Python

PHP

1
2

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

Responses

200

Success

A schema has not been defined for this response code.

Get Options of Custom Field drop down

GET /1/customFields/{id}/options

Get the options of a drop down Custom Field

Request

Path parameters

id Required

string

ID of the customfield.

Pattern: ^[0-9a-fA-F]{24}$

Example

cURL

Node.js

Java

Python

PHP

1
2

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

Responses

200

Success

A schema has not been defined for this response code.

Add Option to Custom Field dropdown

POST /1/customFields/{id}/options

Add an option to a dropdown Custom Field

Request

Path parameters

id Required

string

ID of the customfield.

Pattern: ^[0-9a-fA-F]{24}$

Example

cURL

Node.js

Java

Python

PHP

1
2

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

Responses

200

Success

A schema has not been defined for this response code.

Get Option of Custom Field dropdown

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

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

Request

Path parameters

id Required

string

ID of the customfielditem.

Pattern: ^[0-9a-fA-F]{24}$

idCustomFieldOption Required

string

ID of the customfieldoption to retrieve.

Pattern: ^[0-9a-fA-F]{24}$

Example

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'

Responses

200

Success

A schema has not been defined for this response code.

Delete Option of Custom Field dropdown

DELETE /1/customFields/{id}/options/{idCustomFieldOption}

Delete an option from a Custom Field dropdown.

Request

Path parameters

id Required

string

ID of the customfielditem.

Pattern: ^[0-9a-fA-F]{24}$

idCustomFieldOption Required

string

ID of the customfieldoption to retrieve.

Pattern: ^[0-9a-fA-F]{24}$

Example

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'

Responses

200

Success

A schema has not been defined for this response code.