The Trello REST API

Lists

Get a List

GET /1/lists/{id}

Get information about a List

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the list

Query parameters

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=APIKey&token=APIToken'

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

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the list

Query parameters

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=APIKey&token=APIToken'

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

OAuth scopes required:

NONE

Request

Query parameters

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?name={name}&idBoard=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'

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

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the list

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}/archiveAllCards?key=APIKey&token=APIToken'

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

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the list

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

Query parameters

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?idBoard=5abbe4b7ddc1b351ef961414&idList=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'

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

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the list

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

Query parameters

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=APIKey&token=APIToken'

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

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the list

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

Query parameters

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?value=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'

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

OAuth scopes required:

NONE

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

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=APIKey&token=APIToken'

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

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the list

Query parameters

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=APIKey&token=APIToken'

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

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the list

Query parameters

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=APIKey&token=APIToken'

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

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the list

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

Example

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

Success

Content type	Value
application/json	Array<Card>