Actions
    Applications
    Batch
    Boards
    Cards
    Checklists
    CustomFields
    Emoji
    Enterprises
    Labels
    Lists
    Members
    Notifications
    Organizations
    Plugins
    Search
    Tokens
    Webhooks

    Rate this page:

    Cards

    Create a new Card

    POST /1/cards

    Create a new card

    Request

    Query parameters
    name

    string

    The name for the card

    desc

    string

    The description for the card

    pos

    oneOf [string, number]

    The position of the new card. top, bottom, or a positive float

    due

    string

    A due date for the card

    Format: date
    start

    string

    The start date of a card, or null

    Nullable: true, Format: date
    dueComplete

    boolean

    idList Required

    string

    The ID of the list the card should be created in

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

    Array<string>

    Comma-separated list of member IDs to add to the card

    idLabels

    Array<string>

    Comma-separated list of label IDs to add to the card

    urlSource

    string

    A URL starting with http:// or https://

    Format: url
    fileSource

    string

    Format: binary
    mimeType

    string

    The mimeType of the attachment. Max length 256

    idCardSource

    string

    The ID of a card to copy into the new card

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

    string

    If using idCardSource you can specify which properties to copy over. all or comma-separated list of: attachments,checklists,customFields,comments,due,start,labels,members,start,stickers

    Style: form, Default: all

    Valid values: all, attachments, checklists, comments, customFields, due, start, labels, members, start ...(Show more)

    address

    string

    For use with/by the Map View

    locationName

    string

    For use with/by the Map View

    coordinates

    string

    For use with/by the Map View. Should take the form latitude,longitude

    Example

    1
    2
    3
    curl --request POST \
      --url 'https://api.trello.com/1/cards?idList=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Card

    Get a Card

    GET /1/cards/{id}

    Get a card by its ID

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    all or a comma-separated list of fields. Defaults: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, start, email, idBoard, idChecklists, idLabels, idList, idMembers, idShort, idAttachmentCover, manualCoverAttachment, labels, name, pos, shortUrl, url

    actions

    string

    attachments

    oneOf [string, boolean]

    true, false, or cover

    Default: false
    attachment_fields

    string

    all or a comma-separated list of attachment fields

    Default: all
    members

    boolean

    Whether to return member objects for members on the card

    Default: false
    member_fields

    string

    all or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username

    membersVoted

    boolean

    Whether to return member objects for members who voted on the card

    Default: false
    memberVoted_fields

    string

    all or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username

    checkItemStates

    boolean

    Default: false
    checklists

    string

    Whether to return the checklists on the card. all or none

    Default: none
    checklist_fields

    string

    all or a comma-separated list of idBoard,idCard,name,pos

    Default: all
    board

    boolean

    Whether to return the board object the card is on

    Default: false
    board_fields

    string

    all or a comma-separated list of board fields. Defaults: name, desc, descData, closed, idOrganization, pinned, url, prefs

    list

    boolean

    Default: false
    pluginData

    boolean

    Whether to include pluginData on the card with the response

    Default: false
    stickers

    boolean

    Whether to include sticker models with the response

    Default: false
    sticker_fields

    string

    all or a comma-separated list of sticker fields

    Default: all
    customFieldItems

    boolean

    Whether to include the customFieldItems

    Default: false

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Card

    Update a Card

    PUT /1/cards/{id}

    Update a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The new name for the card

    desc

    string

    The new description for the card

    closed

    boolean

    Whether the card should be archived (closed: true)

    idMembers

    string

    Comma-separated list of member IDs

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

    string

    The ID of the image attachment the card should use as its cover, or null for none

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

    string

    The ID of the list the card should be in

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

    string

    Comma-separated list of label IDs

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

    string

    The ID of the board the card should be on

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

    oneOf [string, number]

    The position of the card in its list. top, bottom, or a positive float

    due

    string

    When the card is due, or null

    Nullable: true, Format: date
    start

    string

    The start date of a card, or null

    Nullable: true, Format: date
    dueComplete

    boolean

    Whether the due date should be marked complete

    subscribed

    boolean

    Whether the member is should be subscribed to the card

    address

    string

    For use with/by the Map View

    locationName

    string

    For use with/by the Map View

    coordinates

    string

    For use with/by the Map View. Should be latitude,longitude

    cover

    object

    Updates the card's cover

    OptionValuesAbout
    colorpink, yellow, lime, blue, black, orange, red, purple, sky, greenMakes the cover a solid color .
    brightnessdark, lightDetermines whether the text on the cover should be dark or light.
    urlAn unsplash URL: https://images.unsplash.comUsed if making an image the cover. Only Unsplash URLs work.
    idAttachmentID of an attachment on the cardUsed if setting an attached image as the cover.
    sizenormal, fullDetermines whether to show the card name on the cover, or below it.

    brightness can be sent alongside any of the other parameters, but all of the other parameters are mutually exclusive; you can not have the cover be a color and an idAttachment at the same time.

    On the brightness options, setting it to light will make the text on the card cover dark:

    And vice versa, setting it to dark will make the text on the card cover light:

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Card

    Delete a Card

    DELETE /1/cards/{id}

    Delete a Card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get a field on a Card

    GET /1/cards/{id}/{field}

    Get a specific property of a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The desired field.

    Valid values: id, address, badges, checkItemStates, closed, coordinates, creationMethod, dueComplete, dateLastActivity, desc ...(Show more)

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Card

    Get Actions on a Card

    GET /1/cards/{id}/actions

    List the Actions on a Card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    A comma-separated list of action types.

    Default: commentCard, updateCard:idList
    page

    number

    The page of results for actions. Each page of results has 50 actions.

    Default: 0, Maximum: 19

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Array<Action>

    Get Attachments on a Card

    GET /1/cards/{id}/attachments

    List the attachments on a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    all or a comma-separated list of attachment fields

    Default: all
    filter

    string

    Use cover to restrict to just the cover attachment

    Default: false

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Array<Attachment>

    Create Attachment On Card

    POST /1/cards/{id}/attachments

    Create an Attachment to a Card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The name of the attachment. Max length 256.

    file

    string

    The file to attach, as multipart/form-data

    Format: binary
    mimeType

    string

    The mimeType of the attachment. Max length 256

    url

    string

    A URL to attach. Must start with http:// or https://

    setCover

    boolean

    Determines whether to use the new attachment as a cover for the Card.

    Default: false

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Array<Attachment>

    Get an Attachment on a Card

    GET /1/cards/{id}/attachments/{idAttachment}

    Get a specific Attachment on a Card.

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the Attachment

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

    Array<string>

    The Attachment fields to be included in the response.

    Style: form

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Array<Attachment>

    Delete an Attachment on a Card

    DELETE /1/cards/{id}/attachments/{idAttachment}

    Delete an Attachment

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the Attachment

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get the Board the Card is on

    GET /1/cards/{id}/board

    Get the board a card is on

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    all or a comma-separated list of board fields

    Default: all

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get checkItems on a Card

    GET /1/cards/{id}/checkItemStates

    Get the completed checklist items on a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    all or a comma-separated list of: idCheckItem, state

    Default: all

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get Checklists on a Card

    GET /1/cards/{id}/checklists

    Get the checklists on a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    all or none

    Default: all

    Valid values: all, none

    checkItem_fields

    string

    all or a comma-separated list of: name,nameData,pos,state,type,due,dueReminder,idMember

    Style: form, Default: name,nameData,pos,state,due,dueReminder,idMember

    Valid values: name, nameData, pos, state, type, due, dueReminder, idMember

    filter

    string

    all or none

    Default: all

    Valid values: all, none

    fields

    string

    all or a comma-separated list of: idBoard,idCard,name,pos

    Style: form, Default: all

    Valid values: all, name, nameData, pos, state, type

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Create Checklist on a Card

    POST /1/cards/{id}/checklists

    Create a new checklist on a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The name of the checklist

    idChecklistSource

    string

    The ID of a source checklist to copy into the new one

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

    string

    The position of the checklist on the card. One of: top, bottom, or a positive number.

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get checkItem on a Card

    GET /1/cards/{id}/checkItem/{idCheckItem}

    Get a specific checkItem on a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the checkitem

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

    string

    all or a comma-separated list of name,nameData,pos,state,type,due,dueReminder,idMember

    Default: name,nameData,pos,state,due,dueReminder,idMember

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Update a checkItem on a Card

    PUT /1/cards/{id}/checkItem/{idCheckItem}

    Update an item in a checklist on a card.

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the checkitem

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

    string

    The new name for the checklist item

    state

    string

    One of: complete, incomplete

    Valid values: complete, incomplete

    idChecklist

    string

    The ID of the checklist this item is in

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

    oneOf [string, number]

    top, bottom, or a positive float

    due

    string

    A due date for the checkitem

    Format: date
    dueReminder

    number

    A dueReminder for the due date on the checkitem

    Nullable: true
    idMember

    string

    The ID of the member to remove from the card

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Delete checkItem on a Card

    DELETE /1/cards/{id}/checkItem/{idCheckItem}

    Delete a checklist item

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the checkitem

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get the List of a Card

    GET /1/cards/{id}/list

    Get the list a card is in

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    all or a comma-separated list of list fields

    Default: all

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get the Members of a Card

    GET /1/cards/{id}/members

    Get the members on a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    all or a comma-separated list of member fields

    Default: avatarHash,fullName,initials,username

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get Members who have voted on a Card

    GET /1/cards/{id}/membersVoted

    Get the members who have voted on a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    all or a comma-separated list of member fields

    Default: avatarHash,fullName,initials,username

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Add Member vote to Card

    POST /1/cards/{id}/membersVoted

    Vote on the card for a given member.

    Request

    Path parameters
    id Required

    string

    The ID of the Card

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    value Required

    string

    The ID of the member to vote 'yes' on the card

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

    Example

    1
    2
    curl --request POST \
      --url 'https://api.trello.com/1/cards/{id}/membersVoted?value=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'

    Responses

    Success

    A schema has not been defined for this response code.

    Get pluginData on a Card

    GET /1/cards/{id}/pluginData

    Get any shared pluginData on a card.

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get Stickers on a Card

    GET /1/cards/{id}/stickers

    Get the stickers on a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    all or a comma-separated list of sticker fields

    Default: all

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Add a Sticker to a Card

    POST /1/cards/{id}/stickers

    Add a sticker to a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    image Required

    string

    For custom stickers, the id of the sticker. For default stickers, the string identifier (like 'taco-cool', see below)

    top Required

    number

    The top position of the sticker, from -60 to 100

    Minimum: -60, Maximum: 100, Format: float
    left Required

    number

    The left position of the sticker, from -60 to 100

    Minimum: -60, Maximum: 100, Format: float
    zIndex Required

    integer

    The z-index of the sticker

    rotate

    number

    The rotation of the sticker

    Default: 0, Minimum: 0, Maximum: 360, Format: float

    Example

    1
    2
    curl --request POST \
      --url 'https://api.trello.com/1/cards/{id}/stickers?image={image}&top={top}&left={left}&zIndex={zIndex}&key=APIKey&token=APIToken'

    Responses

    Success

    A schema has not been defined for this response code.

    Get a Sticker on a Card

    GET /1/cards/{id}/stickers/{idSticker}

    Get a specific sticker on a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the sticker

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

    string

    all or a comma-separated list of sticker fields

    Default: all

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Update a Sticker on a Card

    PUT /1/cards/{id}/stickers/{idSticker}

    Update a sticker on a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the sticker

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    top Required

    number

    The top position of the sticker, from -60 to 100

    Minimum: -60, Maximum: 100, Format: float
    left Required

    number

    The left position of the sticker, from -60 to 100

    Minimum: -60, Maximum: 100, Format: float
    zIndex Required

    integer

    The z-index of the sticker

    rotate

    number

    The rotation of the sticker

    Default: 0, Minimum: 0, Maximum: 360, Format: float

    Example

    1
    2
    curl --request PUT \
      --url 'https://api.trello.com/1/cards/{id}/stickers/{idSticker}?top={top}&left={left}&zIndex={zIndex}&key=APIKey&token=APIToken'

    Responses

    Success

    A schema has not been defined for this response code.

    Delete a Sticker on a Card

    DELETE /1/cards/{id}/stickers/{idSticker}

    Remove a sticker from the card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the sticker

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Update Comment Action on a Card

    PUT /1/cards/{id}/actions/{idAction}/comments

    Update an existing comment

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the comment action to update

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    text Required

    string

    The new text for the comment

    Example

    1
    2
    curl --request PUT \
      --url 'https://api.trello.com/1/cards/{id}/actions/{idAction}/comments?text={text}&key=APIKey&token=APIToken'

    Responses

    Success

    A schema has not been defined for this response code.

    Delete a comment on a Card

    DELETE /1/cards/{id}/actions/{idAction}/comments

    Delete a comment

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the comment action to update

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Update Custom Field item on Card

    PUT /1/cards/{idCard}/customField/{idCustomField}/item

    Setting, updating, and removing the value for a Custom Field on a card. For more details on updating custom fields check out the Getting Started With Custom Fields

    Request

    Path parameters
    idCard Required

    string

    ID of the card that the Custom Field value should be set/updated for

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

    string

    ID of the Custom Field on the card.

    Pattern: ^[0-9a-fA-F]{24}$
    Body parameters
    Content typeValue
    application/json

    oneOf [object, object]

    Example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    curl --request PUT \
      --url 'https://api.trello.com/1/cards/{idCard}/customField/{idCustomField}/item?key=APIKey&token=APIToken' \
      --header 'Content-Type: application/json' \
      --data '{
      "value": {
        "text": "<string>",
        "checked": true,
        "date": "2018-03-13T16:00:00.000Z",
        "number": 2154
      }
    }'

    Responses

    Success

    A schema has not been defined for this response code.

    Get Custom Field Items for a Card

    GET /1/cards/{id}/customFieldItems

    Get the custom field items for a card.

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Array<CustomFieldItems>

    Add a new comment to a Card

    POST /1/cards/{id}/actions/comments

    Add a new comment to a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    text Required

    string

    The comment

    Example

    1
    2
    3
    curl --request POST \
      --url 'https://api.trello.com/1/cards/{id}/actions/comments?text={text}&key=APIKey&token=APIToken' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Action

    Add a Label to a Card

    POST /1/cards/{id}/idLabels

    Add a label to a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the label to add

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Add a Member to a Card

    POST /1/cards/{id}/idMembers

    Add a member to a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the Member to add to the card

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Create a new Label on a Card

    POST /1/cards/{id}/labels

    Create a new label for the board and add it to the given card.

    Request

    Path parameters
    id Required

    string

    The ID of the Card

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    color Required

    string

    A valid label color or null. See labels

    name

    string

    A name for the label

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Mark a Card's Notifications as read

    POST /1/cards/{id}/markAssociatedNotificationsRead

    Mark notifications about this card as read

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Remove a Label from a Card

    DELETE /1/cards/{id}/idLabels/{idLabel}

    Remove a label from a card

    Request

    Path parameters
    id Required

    string

    The ID of the Card

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

    string

    The ID of the label to remove

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Remove a Member from a Card

    DELETE /1/cards/{id}/idMembers/{idMember}

    Remove a member from a card

    Request