Trello Developer

Trello Developer

    Rate this page:

    Labels

    Get a Label

    GET /1/labels/{id}

    Get information about a single Label.

    Request

    Path parameters
    id Required

    string

    The ID of the Label

    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}$
    fields

    string

    all or a comma-separated list of fields

    Default: all

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Update a Label

    PUT /1/labels/{id}

    Update a label by ID.

    Request

    Path parameters
    id Required

    string

    The ID of the Label

    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}$
    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

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

    Responses

    Success

    A schema has not been defined for this response code.

    Delete a Label

    DELETE /1/labels/{id}

    Delete a label by ID.

    Request

    Path parameters
    id Required

    string

    The ID of the Label

    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

    1
2
    curl --request DELETE \
  --url 'https://api.trello.com/1/labels/{id}'

    Responses

    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.

    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
    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 new value for the field.

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Create a Label

    POST /1/labels

    Create a new Label 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 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

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

    Responses

    Success

    A schema has not been defined for this response code.

    Rate this page: