Actions
    Applications
    Batch
    Boards
    Cards
    Checklists
    CustomFields
    Emoji
    Enterprises
    Labels
    Lists
    Members
    Notifications
    Organizations
    Plugins
    Search
    Tokens
    Webhooks

    Rate this page:

    Checklists

    Create a Checklist

    POST /1/checklists

    Request

    Query parameters
    idCard Required

    string

    The ID of the Card that the checklist should be added to.

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

    string

    The name of the checklist. Should be a string of length 1 to 16384.

    Min length: 1, Max length: 16384
    pos

    oneOf [string, number]

    The position of the checklist on the card. One of: top, bottom, or a positive number.

    idChecklistSource

    string

    The ID of a checklist to copy into the new checklist.

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

    Example

    1
    2
    curl --request POST \
      --url 'https://api.trello.com/1/checklists?idCard=5abbe4b7ddc1b351ef961414'

    Responses

    Success

    A schema has not been defined for this response code.

    Get a Checklist

    GET /1/checklists/{id}

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

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

    string

    Valid values: all, closed, none, open, visible. Cards is a nested resource. The additional query params available are documented at Cards Nested Resource.

    Default: none

    Valid values: all, closed, none, open, visible

    checkItems

    string

    The check items on the list to return. One of: all, none.

    Default: all

    Valid values: all, none

    checkItem_fields

    string

    The fields on the checkItem to return if checkItems are being returned. all or a comma-separated list of: name, nameData, pos, state, type

    Default: name, nameData, pos, state

    Valid values: all, name, nameData, pos, state, type

    fields

    string

    all or a comma-separated list of checklist fields

    Default: all

    Example

    1
    2
    curl --request GET \
      --url 'https://api.trello.com/1/checklists/{id}'

    Responses

    Success

    A schema has not been defined for this response code.

    Update a Checklist

    PUT /1/checklists/{id}

    Update an existing checklist.

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

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

    string

    Name of the new checklist being created. Should be length of 1 to 16384.

    pos

    oneOf [string, number]

    Determines the position of the checklist on the card. One of: top, bottom, or a positive number.

    Example

    1
    2
    curl --request PUT \
      --url 'https://api.trello.com/1/checklists/{id}'

    Responses

    Success

    A schema has not been defined for this response code.

    Delete a Checklist

    DELETE /1/checklists/{id}

    Delete a checklist

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

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

    Example

    1
    2
    curl --request DELETE \
      --url 'https://api.trello.com/1/checklists/{id}'

    Responses

    Success

    A schema has not been defined for this response code.

    Get field on a Checklist

    GET /1/checklists/{id}/{field}

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

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

    string

    Field to update.

    Valid values: name, pos

    Example

    1
    2
    curl --request GET \
      --url 'https://api.trello.com/1/checklists/{id}/{field}'

    Responses

    Success

    A schema has not been defined for this response code.

    Update field on a Checklist

    PUT /1/checklists/{id}/{field}

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

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

    string

    Field to update.

    Valid values: name, pos

    Query parameters
    value Required

    oneOf [oneOf [string, number], string]

    The value to change the checklist name to. Should be a string of length 1 to 16384.

    Example

    1
    2
    curl --request PUT \
      --url 'https://api.trello.com/1/checklists/{id}/{field}?value={value}'

    Responses

    Success

    A schema has not been defined for this response code.

    Get the Board the Checklist is on

    GET /1/checklists/{id}/board

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

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

    string

    all or a comma-separated list of board fields

    Default: all

    Valid values: all, name

    Example

    1
    2
    curl --request GET \
      --url 'https://api.trello.com/1/checklists/{id}/board'

    Responses

    Success

    A schema has not been defined for this response code.

    Get the Card a Checklist is on

    GET /1/checklists/{id}/cards

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

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

    Example

    1
    2
    curl --request GET \
      --url 'https://api.trello.com/1/checklists/{id}/cards'

    Responses

    Success

    A schema has not been defined for this response code.

    Get Checkitems on a Checklist

    GET /1/checklists/{id}/checkItems

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

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

    string

    One of: all, none.

    Default: all

    Valid values: all, none

    fields

    string

    One of: all, name, nameData, pos, state, type.

    Style: form, Default: name, nameData, pos, state

    Valid values: all, name, nameData, pos, state, type

    Example

    1
    2
    curl --request GET \
      --url 'https://api.trello.com/1/checklists/{id}/checkItems'

    Responses

    Success

    A schema has not been defined for this response code.

    Create Checkitem on Checklist

    POST /1/checklists/{id}/checkItems

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    name Required

    string

    The name of the new check item on the checklist. Should be a string of length 1 to 16384.

    Min length: 1, Max length: 16384
    pos

    oneOf [string, number]

    The position of the check item in the checklist. One of: top, bottom, or a positive number.

    checked

    boolean

    Determines whether the check item is already checked when created.

    Default: false

    Example

    1
    2
    curl --request POST \
      --url 'https://api.trello.com/1/checklists/{id}/checkItems?name={name}'

    Responses

    Success

    A schema has not been defined for this response code.

    Get a Checkitem on a Checklist

    GET /1/checklists/{id}/checkItems/{idCheckItem}

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

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

    string

    ID of the check item to retrieve.

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

    string

    One of: all, name, nameData, pos, state, type.

    Style: form, Default: name, nameData, pos, state

    Valid values: all, name, nameData, pos, state, type

    Example

    1
    2
    curl --request GET \
      --url 'https://api.trello.com/1/checklists/{id}/checkItems/{idCheckItem}'

    Responses

    Success

    A schema has not been defined for this response code.

    Delete Checkitem from Checklist

    DELETE /1/checklists/{id}/checkItems/{idCheckItem}

    Remove an item from a checklist

    Request

    Path parameters
    id Required

    string

    ID of a checklist.

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

    string

    ID of the check item to retrieve.

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

    Example

    1
    2
    curl --request DELETE \
      --url 'https://api.trello.com/1/checklists/{id}/checkItems/{idCheckItem}'

    Responses

    Success

    A schema has not been defined for this response code.

    Rate this page: