The Trello REST API

Labels

Get a Label

GET /1/labels/{id}

Get information about a single Label.

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the Label

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

Query parameters

fields

string

all or a comma-separated list of fields

Default: all

Example

cURL

Node.js

Java

Python

PHP

1
2

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

Responses

200

Success

A schema has not been defined for this response code.

Update a Label

PUT /1/labels/{id}

Update a label by ID.

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the Label

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

Query parameters

name

string

The new name for the label

color

string

The new color for the label. See: fields for color options

Nullable: true

Valid values: yellow, purple, blue, red, green, orange, black, sky, pink, lime

Example

cURL

Node.js

Java

Python

PHP

1
2

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

Responses

200

Success

A schema has not been defined for this response code.

Delete a Label

DELETE /1/labels/{id}

Delete a label by ID.

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The ID of the Label

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

Example

cURL

Node.js

Java

Python

PHP

1
2

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

Responses

200

Success

A schema has not been defined for this response code.

Update a field on a label

PUT /1/labels/{id}/{field}

Update a field on a label.

OAuth scopes required:

NONE

Request

Path parameters

id Required

string

The id of the label

field Required

string

The field on the Label to update.

Valid values: color, name

Query parameters

value Required

string

The new value for the field.

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

Example

cURL

Node.js

Java

Python

PHP

1
2

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

Responses

200

Success

A schema has not been defined for this response code.

Create a Label

POST /1/labels

Create a new Label on a Board.

OAuth scopes required:

NONE

Request

Query parameters

name Required

string

Name for the label

color Required

string

The color for the label.

Nullable: true

Valid values: yellow, purple, blue, red, green, orange, black, sky, pink, lime

idBoard Required

string

The ID of the Board to create the Label on.

Example

cURL

Node.js

Java

Python

PHP

1
2

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

Responses

200

Success

A schema has not been defined for this response code.