The Trello REST API

Lists

Get a List

GET /1/lists/{id}

Get information about a List

Request

Path parameters

id Required

string

The ID of the list

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

fields

string

all or a comma separated list of List field names.

Style: form, Default: name,closed,idBoard,pos

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://api.trello.com/1/lists/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.

Update a List

PUT /1/lists/{id}

Update the properties of a List

Request

Path parameters

id Required

string

The ID of the list

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

name

string

New name for the list

closed

boolean

Whether the list should be closed (archived)

idBoard

string

ID of a board the list should be moved to

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

pos

oneOf [number, string]

New position for the list: top, bottom, or a positive floating point number

subscribed

boolean

Whether the active member is subscribed to this list

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request PUT \
  --url 'https://api.trello.com/1/lists/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.

Create a new List

POST /1/lists

Create a new List on a Board

Request

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

name Required

string

Name for the list

idBoard Required

string

The long ID of the board the list should be created on

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

idListSource

string

ID of the List to copy into the new List

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

pos

oneOf [number, string]

Position of the list. top, bottom, or a positive floating point number

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'https://api.trello.com/1/lists?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&name={name}&idBoard=5abbe4b7ddc1b351ef961414'

Responses

200

Success

A schema has not been defined for this response code.

Archive all Cards in List

POST /1/lists/{id}/archiveAllCards

Archive all cards in a list

Request

Path parameters

id Required

string

The ID of the list

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'https://api.trello.com/1/lists/{id}/archiveAllCards?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.

Move all Cards in List

POST /1/lists/{id}/moveAllCards

Move all Cards in a List

Request

Path parameters

id Required

string

The ID of the list

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

idBoard Required

string

The ID of the board the cards should be moved to

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

idList Required

string

The ID of the list that the cards should be moved to

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'https://api.trello.com/1/lists/{id}/moveAllCards?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&idBoard=5abbe4b7ddc1b351ef961414&idList=5abbe4b7ddc1b351ef961414'

Responses

200

Success

A schema has not been defined for this response code.

Archive or unarchive a list

PUT /1/lists/{id}/closed

Archive or unarchive a list

Request

Path parameters

id Required

string

The ID of the list

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

value

string

Set to true to close (archive) the list

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request PUT \
  --url 'https://api.trello.com/1/lists/{id}/closed?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.

Move List to Board

PUT /1/lists/{id}/idBoard

Move a List to a different Board

Request

Path parameters

id Required

string

The ID of the list

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

value Required

string

The ID of the board to move the list to

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request PUT \
  --url 'https://api.trello.com/1/lists/{id}/idBoard?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value=5abbe4b7ddc1b351ef961414'

Responses

200

Success

A schema has not been defined for this response code.

Update a field on a List

PUT /1/lists/{id}/{field}

Rename a list

Request

Path parameters

id Required

string

The ID of the list

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

field Required

string

The field on the List to be updated

Valid values: name, pos, subscribed

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

value

oneOf [string, number, string, boolean]

The new value for the field

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request PUT \
  --url 'https://api.trello.com/1/lists/{id}/{field}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.

Get Actions for a List

GET /1/lists/{id}/actions

Get the Actions on a List

Request

Path parameters

id Required

string

The ID of the list

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

filter

string

A comma-separated list of action types.

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://api.trello.com/1/lists/{id}/actions?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.

Get the Board a List is on

GET /1/lists/{id}/board

Get the board a list is on

Request

Path parameters

id Required

string

The ID of the list

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

fields

string

all or a comma-separated list of board fields

Default: all

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://api.trello.com/1/lists/{id}/board?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.

Get Cards in a List

GET /1/lists/{id}/cards

List the cards in a list

Request

Path parameters

id Required

string

The ID of the list

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://api.trello.com/1/lists/{id}/cards?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.