• Actions
    • Applications
    • Batch
    • Boards
    • Cards
    • Checklists
    • CustomFields
    • Emoji
    • Enterprises
    • Labels
    • Lists
    • Members
    • Notifications
    • Organizations
    • Plugins
    • Search
    • Tokens
    • Webhooks
    Cloud
    Trello / Reference / REST API

    Rate this page:

    CustomFields

    Postman Collection
    OpenAPI
    Operations
    POST/customFieldsGET/customFields/{id}PUT/customFields/{id}DEL/customFields/{id}GET/customFields/{id}/optionsPOST/customFields/{id}/optionsGET/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.

    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
    1 2 3 4 5 6 7 8 9 10 11 12 13 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
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "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

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

    application/json

    CustomField
    GET/customFields/{id}
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/customFields/{id}?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "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.

    Request

    Path parameters

    id

    TrelloID

    Required

    Request bodyapplication/json

    name

    string

    pos

    oneOf [string, number]

    display/cardFront

    boolean

    Responses

    Success

    application/json

    CustomField
    PUT/customFields/{id}
    1 2 3 4 5 6 7 8 9 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
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "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.

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

    DEL/customFields/{id}
    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

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

    GET/customFields/{id}/options
    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

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

    POST/customFields/{id}/options
    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

    Request

    Path parameters

    id

    TrelloID

    Required
    idCustomFieldOption

    TrelloID

    Required

    Responses

    Success

    GET/customFields/{id}/options/{idCustomFieldOption}
    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.

    Request

    Path parameters

    id

    TrelloID

    Required
    idCustomFieldOption

    TrelloID

    Required

    Responses

    Success

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