Rate this page:
POST /1/checklists
string
The ID of the Card that the checklist should be added to.
^[0-9a-fA-F]{24}$
string
The name of the checklist. Should be a string of length 1 to 16384.
1
, Max length: 16384
oneOf [string, number]
The position of the checklist on the card. One of: top
, bottom
, or a positive number.
string
The ID of a checklist to copy into the new checklist.
^[0-9a-fA-F]{24}$
1 2
curl --request POST \
--url 'https://api.trello.com/1/checklists?idCard=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/checklists/{id}
string
ID of a checklist.
^[0-9a-fA-F]{24}$
string
Valid values: all
, closed
, none
, open
, visible
. Cards is a nested resource. The additional query params available are documented at Cards Nested Resource.
none
Valid values: all
, closed
, none
, open
, visible
string
The check items on the list to return. One of: all
, none
.
all
Valid values: all
, none
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
, due
, dueReminder
, idMember
name, nameData, pos, state, due, dueReminder, idMember
Valid values: all
, name
, nameData
, pos
, state
, type
, due
, dueReminder
, idMember
string
all
or a comma-separated list of checklist fields
all
1 2
curl --request GET \
--url 'https://api.trello.com/1/checklists/{id}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
PUT /1/checklists/{id}
Update an existing checklist.
string
ID of a checklist.
^[0-9a-fA-F]{24}$
string
Name of the new checklist being created. Should be length of 1 to 16384.
oneOf [string, number]
Determines the position of the checklist on the card. One of: top
, bottom
, or a positive number.
1 2
curl --request PUT \
--url 'https://api.trello.com/1/checklists/{id}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/checklists/{id}
Delete a checklist
string
ID of a checklist.
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/checklists/{id}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/checklists/{id}/{field}
string
ID of a checklist.
^[0-9a-fA-F]{24}$
string
Field to update.
Valid values: name
, pos
1 2
curl --request GET \
--url 'https://api.trello.com/1/checklists/{id}/{field}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
PUT /1/checklists/{id}/{field}
string
ID of a checklist.
^[0-9a-fA-F]{24}$
string
Field to update.
Valid values: name
, pos
oneOf [oneOf [string, number], string]
The value to change the checklist name to. Should be a string of length 1 to 16384.
1 2
curl --request PUT \
--url 'https://api.trello.com/1/checklists/{id}/{field}?value={value}&key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/checklists/{id}/board
string
ID of a checklist.
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of board fields
all
Valid values: all
, name
1 2
curl --request GET \
--url 'https://api.trello.com/1/checklists/{id}/board?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/checklists/{id}/cards
string
ID of a checklist.
^[0-9a-fA-F]{24}$
1 2
curl --request GET \
--url 'https://api.trello.com/1/checklists/{id}/cards?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/checklists/{id}/checkItems
string
ID of a checklist.
^[0-9a-fA-F]{24}$
string
One of: all
, none
.
all
Valid values: all
, none
string
One of: all
, name
, nameData
, pos
, state
,type
, due
, dueReminder
, idMember
.
form
, Default: name, nameData, pos, state, due, dueReminder, idMember
Valid values: all
, name
, nameData
, pos
, state
, type
, due
, dueReminder
, idMember
1 2
curl --request GET \
--url 'https://api.trello.com/1/checklists/{id}/checkItems?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
POST /1/checklists/{id}/checkItems
string
ID of a checklist.
^[0-9a-fA-F]{24}$
string
The name of the new check item on the checklist. Should be a string of length 1 to 16384.
1
, Max length: 16384
oneOf [string, number]
The position of the check item in the checklist. One of: top
, bottom
, or a positive number.
boolean
Determines whether the check item is already checked when created.
false
string
A due date for the checkitem
date
number
A dueReminder for the due date on the checkitem
true
string
An ID of a member resource.
^[0-9a-fA-F]{24}$
1 2
curl --request POST \
--url 'https://api.trello.com/1/checklists/{id}/checkItems?name={name}&key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/checklists/{id}/checkItems/{idCheckItem}
string
ID of a checklist.
^[0-9a-fA-F]{24}$
string
ID of the check item to retrieve.
^[0-9a-fA-F]{24}$
string
One of: all
, name
, nameData
, pos
, state
, type
, due
, dueReminder
, idMember
,.
form
, Default: name, nameData, pos, state, due, dueReminder, idMember
Valid values: all
, name
, nameData
, pos
, state
, type
, due
, dueReminder
, idMember
1 2
curl --request GET \
--url 'https://api.trello.com/1/checklists/{id}/checkItems/{idCheckItem}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/checklists/{id}/checkItems/{idCheckItem}
Remove an item from a checklist
string
ID of a checklist.
^[0-9a-fA-F]{24}$
string
ID of the check item to retrieve.
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/checklists/{id}/checkItems/{idCheckItem}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
Rate this page: