Rate this page:
GET /1/lists/{id}
Get information about a List
string
The ID of the list
string
all or a comma separated list of List field names.
form, Default: name,closed,idBoard,pos1 2
curl --request GET \
--url 'https://api.trello.com/1/lists/{id}'Success
A schema has not been defined for this response code.
PUT /1/lists/{id}
Update the properties of a List
string
The ID of the list
string
New name for the list
boolean
Whether the list should be closed (archived)
string
ID of a board the list should be moved to
form, Pattern: ^[0-9a-fA-F]{24}$oneOf [number, string]
New position for the list: top, bottom, or a positive floating point number
boolean
Whether the active member is subscribed to this list
1 2
curl --request PUT \
--url 'https://api.trello.com/1/lists/{id}'Success
A schema has not been defined for this response code.
POST /1/lists
Create a new List on a Board
string
Name for the list
string
The long ID of the board the list should be created on
^[0-9a-fA-F]{24}$string
ID of the List to copy into the new List
^[0-9a-fA-F]{24}$oneOf [number, string]
Position of the list. top, bottom, or a positive floating point number
1 2
curl --request POST \
--url 'https://api.trello.com/1/lists?name={name}&idBoard=5abbe4b7ddc1b351ef961414'Success
A schema has not been defined for this response code.
POST /1/lists/{id}/archiveAllCards
Archive all cards in a list
string
The ID of the list
^[0-9a-fA-F]{24}$1 2
curl --request POST \
--url 'https://api.trello.com/1/lists/{id}/archiveAllCards'Success
A schema has not been defined for this response code.
POST /1/lists/{id}/moveAllCards
Move all Cards in a List
string
The ID of the list
^[0-9a-fA-F]{24}$string
The ID of the board the cards should be moved to
^[0-9a-fA-F]{24}$string
The ID of the list that the cards should be moved to
^[0-9a-fA-F]{24}$1 2
curl --request POST \
--url 'https://api.trello.com/1/lists/{id}/moveAllCards?idBoard=5abbe4b7ddc1b351ef961414&idList=5abbe4b7ddc1b351ef961414'Success
A schema has not been defined for this response code.
PUT /1/lists/{id}/closed
Archive or unarchive a list
string
The ID of the list
^[0-9a-fA-F]{24}$string
Set to true to close (archive) the list
^[0-9a-fA-F]{24}$1 2
curl --request PUT \
--url 'https://api.trello.com/1/lists/{id}/closed'Success
A schema has not been defined for this response code.
PUT /1/lists/{id}/idBoard
Move a List to a different Board
string
The ID of the list
^[0-9a-fA-F]{24}$string
The ID of the board to move the list to
^[0-9a-fA-F]{24}$1 2
curl --request PUT \
--url 'https://api.trello.com/1/lists/{id}/idBoard?value=5abbe4b7ddc1b351ef961414'Success
A schema has not been defined for this response code.
PUT /1/lists/{id}/{field}
Rename a list
string
The ID of the list
^[0-9a-fA-F]{24}$string
The field on the List to be updated
Valid values: name, pos, subscribed
oneOf [string, number, string, boolean]
The new value for the field
1 2
curl --request PUT \
--url 'https://api.trello.com/1/lists/{id}/{field}'Success
A schema has not been defined for this response code.
GET /1/lists/{id}/actions
Get the Actions on a List
string
The ID of the list
string
A comma-separated list of action types.
1 2
curl --request GET \
--url 'https://api.trello.com/1/lists/{id}/actions'Success
A schema has not been defined for this response code.
GET /1/lists/{id}/board
Get the board a list is on
string
The ID of the list
string
all or a comma-separated list of board fields
all1 2
curl --request GET \
--url 'https://api.trello.com/1/lists/{id}/board'Success
A schema has not been defined for this response code.
GET /1/lists/{id}/cards
List the cards in a list
string
The ID of the list
^[0-9a-fA-F]{24}$1 2 3
curl --request GET \
--url 'https://api.trello.com/1/lists/{id}/cards' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json | Array<Card> |
Rate this page: