Cloud

Trello / Reference / REST API

Checklists

Operations

POST/checklists GET/checklists/{id}PUT/checklists/{id}DEL/checklists/{id}GET/checklists/{id}/{field}PUT/checklists/{id}/{field}GET/checklists/{id}/board GET/checklists/{id}/cards GET/checklists/{id}/checkItems POST/checklists/{id}/checkItems GET/checklists/{id}/checkItems/{idCheckItem}DEL/checklists/{id}/checkItems/{idCheckItem}

POST

Create a Checklist

Request

Query parameters

idCard

TrelloID

Required

name

string

pos

oneOf [string, number]

idChecklistSource

TrelloID

Responses

Success

POST/checklists

curl

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'https://api.trello.com/1/checklists?idCard=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'

GET

Get a Checklist

Request

Path parameters

TrelloID

Required

Query parameters

cards

string

checkItems

string

checkItem_fields

string

fields

string

Responses

Success

GET/checklists/{id}

curl

Node.js

Java

Python

PHP

1
2

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

PUT

Update a Checklist

Update an existing checklist.

Request

Path parameters

TrelloID

Required

Query parameters

name

string

pos

oneOf [string, number]

Responses

Success

PUT/checklists/{id}

curl

Node.js

Java

Python

PHP

1
2

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

DEL

Delete a Checklist

Delete a checklist

Request

Path parameters

TrelloID

Required

Responses

Success

DEL/checklists/{id}

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get field on a Checklist

Request

Path parameters

TrelloID

Required

field

string

Required

Responses

Success

GET/checklists/{id}/{field}

curl

Node.js

Java

Python

PHP

1
2

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

PUT

Update field on a Checklist

Request

Path parameters

TrelloID

Required

field

string

Required

Query parameters

value

oneOf [oneOf [string, number], TrelloID]

Required

Responses

Success

PUT/checklists/{id}/{field}

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get the Board the Checklist is on

Request

Path parameters

TrelloID

Required

Query parameters

fields

string

Responses

Success

GET/checklists/{id}/board

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get the Card a Checklist is on

Request

Path parameters

TrelloID

Required

Responses

Success

GET/checklists/{id}/cards

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get Checkitems on a Checklist

Request

Path parameters

TrelloID

Required

Query parameters

filter

string

fields

string

Responses

Success

GET/checklists/{id}/checkItems

curl

Node.js

Java

Python

PHP

1
2

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

POST

Create Checkitem on Checklist

Request

Path parameters

TrelloID

Required

Query parameters

name

string

Required

pos

oneOf [string, number]

checked

boolean

due

string

dueReminder

number

idMember

TrelloID

Responses

Success

POST/checklists/{id}/checkItems

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get a Checkitem on a Checklist

Request

Path parameters

TrelloID

Required

idCheckItem

TrelloID

Required

Query parameters

fields

string

Responses

Success

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

curl

Node.js

Java

Python

PHP

1
2

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

DEL

Delete Checkitem from Checklist

Remove an item from a checklist

Request

Path parameters

TrelloID

Required

idCheckItem

TrelloID

Required

Responses

Success

DEL/checklists/{id}/checkItems/{idCheckItem}

curl

Node.js

Java

Python

PHP

1
2

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