Cloud

Trello / Reference / REST API

Cards

Operations

POST/cards GET/cards/{id}PUT/cards/{id}DEL/cards/{id}GET/cards/{id}/{field}GET/cards/{id}/actions GET/cards/{id}/attachments POST/cards/{id}/attachments GET/cards/{id}/attachments/{idAttachment}DEL/cards/{id}/attachments/{idAttachment}GET/cards/{id}/board GET/cards/{id}/checkItemStates GET/cards/{id}/checklists POST/cards/{id}/checklists GET/cards/{id}/checkItem/{idCheckItem}PUT/cards/{id}/checkItem/{idCheckItem}DEL/cards/{id}/checkItem/{idCheckItem}GET/cards/{id}/list GET/cards/{id}/members GET/cards/{id}/membersVoted POST/cards/{id}/membersVoted GET/cards/{id}/pluginData GET/cards/{id}/stickers POST/cards/{id}/stickers GET/cards/{id}/stickers/{idSticker}PUT/cards/{id}/stickers/{idSticker}DEL/cards/{id}/stickers/{idSticker}PUT/cards/{id}/actions/{idAction}/comments DEL/cards/{id}/actions/{idAction}/comments PUT/cards/{idCard}/customField/{idCustomField}/item PUT/cards/{idCard}/customFields GET/cards/{id}/customFieldItems POST/cards/{id}/actions/comments POST/cards/{id}/idLabels POST/cards/{id}/idMembers POST/cards/{id}/labels POST/cards/{id}/markAssociatedNotificationsRead DEL/cards/{id}/idLabels/{idLabel}DEL/cards/{id}/idMembers/{idMember}DEL/cards/{id}/membersVoted/{idMember}PUT/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}DEL/cards/{id}/checklists/{idChecklist}

POST

Create a new Card

Create a new card. Query parameters may also be replaced with a JSON request body instead.

Request

Query parameters

name

string

desc

string

pos

oneOf [string, number]

due

string

start

string

dueComplete

boolean

idList

TrelloID

Required

idMembers

array<TrelloID>

idLabels

array<TrelloID>

urlSource

string

Responses

Success

application/json

Card

POST/cards

curl

Node.js

Java

Python

PHP

1
2
3

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

200Response

{
  "id": "5abbe4b7ddc1b351ef961414",
  "address": "<string>",
  "badges": {
    "attachmentsByType": {
      "trello": {
        "board": 2154,
        "card": 2154
      }
    },
    "location": true,
    "votes": 2154,
    "viewingMemberVoted": false,
    "subscribed": false,
    "fogbugz": "<string>",
    "checkItems": 0,
    "checkItemsChecked": 0,
    "comments": 0,
    "attachments": 0,
    "description": true,
    "due": "<string>",
    "start": "<string>",
    "dueComplete": true
  },
  "checkItemStates": [
    "<string>"
  ],
  "closed": true,
  "coordinates": "<string>",
  "creationMethod": "<string>",
  "dateLastActivity": "2019-09-16T16:19:17.156Z",
  "desc": "👋Hey there,\n\nTrello's Platform team uses this board to keep developers up-to-date.",
  "descData": {
    "emoji": {}
  },
  "due": "<string>",
  "dueReminder": "<string>",
  "idBoard": "5abbe4b7ddc1b351ef961414",
  "idChecklists": [
    {
      "id": "5abbe4b7ddc1b351ef961414"
    }
  ],
  "idLabels": [
    {
      "id": "5abbe4b7ddc1b351ef961414",
      "idBoard": "5abbe4b7ddc1b351ef961414",
      "name": "Overdue",
      "color": "yellow"
    }
  ],
  "idList": "5abbe4b7ddc1b351ef961414",
  "idMembers": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "idMembersVoted": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "idShort": 2154,
  "labels": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "limits": {
    "attachments": {
      "perBoard": {
        "status": "ok",
        "disableAt": 36000,
        "warnAt": 32400
      }
    }
  },
  "locationName": "<string>",
  "manualCoverAttachment": false,
  "name": "👋 What? Why? How?",
  "pos": 65535,
  "shortLink": "H0TZyzbK",
  "shortUrl": "https://trello.com/c/H0TZyzbK",
  "subscribed": false,
  "url": "https://trello.com/c/H0TZyzbK/4-%F0%9F%91%8B-what-why-how",
  "cover": {
    "color": "yellow",
    "idUploadedBackground": true,
    "size": "normal",
    "brightness": "light",
    "isTemplate": false
  }
}

GET

Get a Card

Get a card by its ID

Request

Path parameters

TrelloID

Required

Query parameters

fields

string

actions

string

attachments

oneOf [string, boolean]

attachment_fields

string

members

boolean

member_fields

string

membersVoted

boolean

memberVoted_fields

string

checkItemStates

boolean

checklists

string

Responses

Success

application/json

Card

GET/cards/{id}

curl

Node.js

Java

Python

PHP

1
2
3

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

200Response

{
  "id": "5abbe4b7ddc1b351ef961414",
  "address": "<string>",
  "badges": {
    "attachmentsByType": {
      "trello": {
        "board": 2154,
        "card": 2154
      }
    },
    "location": true,
    "votes": 2154,
    "viewingMemberVoted": false,
    "subscribed": false,
    "fogbugz": "<string>",
    "checkItems": 0,
    "checkItemsChecked": 0,
    "comments": 0,
    "attachments": 0,
    "description": true,
    "due": "<string>",
    "start": "<string>",
    "dueComplete": true
  },
  "checkItemStates": [
    "<string>"
  ],
  "closed": true,
  "coordinates": "<string>",
  "creationMethod": "<string>",
  "dateLastActivity": "2019-09-16T16:19:17.156Z",
  "desc": "👋Hey there,\n\nTrello's Platform team uses this board to keep developers up-to-date.",
  "descData": {
    "emoji": {}
  },
  "due": "<string>",
  "dueReminder": "<string>",
  "idBoard": "5abbe4b7ddc1b351ef961414",
  "idChecklists": [
    {
      "id": "5abbe4b7ddc1b351ef961414"
    }
  ],
  "idLabels": [
    {
      "id": "5abbe4b7ddc1b351ef961414",
      "idBoard": "5abbe4b7ddc1b351ef961414",
      "name": "Overdue",
      "color": "yellow"
    }
  ],
  "idList": "5abbe4b7ddc1b351ef961414",
  "idMembers": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "idMembersVoted": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "idShort": 2154,
  "labels": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "limits": {
    "attachments": {
      "perBoard": {
        "status": "ok",
        "disableAt": 36000,
        "warnAt": 32400
      }
    }
  },
  "locationName": "<string>",
  "manualCoverAttachment": false,
  "name": "👋 What? Why? How?",
  "pos": 65535,
  "shortLink": "H0TZyzbK",
  "shortUrl": "https://trello.com/c/H0TZyzbK",
  "subscribed": false,
  "url": "https://trello.com/c/H0TZyzbK/4-%F0%9F%91%8B-what-why-how",
  "cover": {
    "color": "yellow",
    "idUploadedBackground": true,
    "size": "normal",
    "brightness": "light",
    "isTemplate": false
  }
}

PUT

Update a Card

Update a card. Query parameters may also be replaced with a JSON request body instead.

Request

Path parameters

TrelloID

Required

Query parameters

name

string

desc

string

closed

boolean

idMembers

TrelloID

idAttachmentCover

TrelloID

idList

TrelloID

idLabels

TrelloID

idBoard

TrelloID

pos

oneOf [string, number]

due

string

Responses

Success

application/json

Card

PUT/cards/{id}

curl

Node.js

Java

Python

PHP

1
2
3

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

200Response

{
  "id": "5abbe4b7ddc1b351ef961414",
  "address": "<string>",
  "badges": {
    "attachmentsByType": {
      "trello": {
        "board": 2154,
        "card": 2154
      }
    },
    "location": true,
    "votes": 2154,
    "viewingMemberVoted": false,
    "subscribed": false,
    "fogbugz": "<string>",
    "checkItems": 0,
    "checkItemsChecked": 0,
    "comments": 0,
    "attachments": 0,
    "description": true,
    "due": "<string>",
    "start": "<string>",
    "dueComplete": true
  },
  "checkItemStates": [
    "<string>"
  ],
  "closed": true,
  "coordinates": "<string>",
  "creationMethod": "<string>",
  "dateLastActivity": "2019-09-16T16:19:17.156Z",
  "desc": "👋Hey there,\n\nTrello's Platform team uses this board to keep developers up-to-date.",
  "descData": {
    "emoji": {}
  },
  "due": "<string>",
  "dueReminder": "<string>",
  "idBoard": "5abbe4b7ddc1b351ef961414",
  "idChecklists": [
    {
      "id": "5abbe4b7ddc1b351ef961414"
    }
  ],
  "idLabels": [
    {
      "id": "5abbe4b7ddc1b351ef961414",
      "idBoard": "5abbe4b7ddc1b351ef961414",
      "name": "Overdue",
      "color": "yellow"
    }
  ],
  "idList": "5abbe4b7ddc1b351ef961414",
  "idMembers": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "idMembersVoted": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "idShort": 2154,
  "labels": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "limits": {
    "attachments": {
      "perBoard": {
        "status": "ok",
        "disableAt": 36000,
        "warnAt": 32400
      }
    }
  },
  "locationName": "<string>",
  "manualCoverAttachment": false,
  "name": "👋 What? Why? How?",
  "pos": 65535,
  "shortLink": "H0TZyzbK",
  "shortUrl": "https://trello.com/c/H0TZyzbK",
  "subscribed": false,
  "url": "https://trello.com/c/H0TZyzbK/4-%F0%9F%91%8B-what-why-how",
  "cover": {
    "color": "yellow",
    "idUploadedBackground": true,
    "size": "normal",
    "brightness": "light",
    "isTemplate": false
  }
}

DEL

Delete a Card

Request

Path parameters

TrelloID

Required

Responses

Success

DEL/cards/{id}

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get a field on a Card

Get a specific property of a card

Request

Path parameters

TrelloID

Required

field

CardFields

Required

Responses

Success

application/json

Card

GET/cards/{id}/{field}

curl

Node.js

Java

Python

PHP

1
2
3

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

200Response

{
  "id": "5abbe4b7ddc1b351ef961414",
  "address": "<string>",
  "badges": {
    "attachmentsByType": {
      "trello": {
        "board": 2154,
        "card": 2154
      }
    },
    "location": true,
    "votes": 2154,
    "viewingMemberVoted": false,
    "subscribed": false,
    "fogbugz": "<string>",
    "checkItems": 0,
    "checkItemsChecked": 0,
    "comments": 0,
    "attachments": 0,
    "description": true,
    "due": "<string>",
    "start": "<string>",
    "dueComplete": true
  },
  "checkItemStates": [
    "<string>"
  ],
  "closed": true,
  "coordinates": "<string>",
  "creationMethod": "<string>",
  "dateLastActivity": "2019-09-16T16:19:17.156Z",
  "desc": "👋Hey there,\n\nTrello's Platform team uses this board to keep developers up-to-date.",
  "descData": {
    "emoji": {}
  },
  "due": "<string>",
  "dueReminder": "<string>",
  "idBoard": "5abbe4b7ddc1b351ef961414",
  "idChecklists": [
    {
      "id": "5abbe4b7ddc1b351ef961414"
    }
  ],
  "idLabels": [
    {
      "id": "5abbe4b7ddc1b351ef961414",
      "idBoard": "5abbe4b7ddc1b351ef961414",
      "name": "Overdue",
      "color": "yellow"
    }
  ],
  "idList": "5abbe4b7ddc1b351ef961414",
  "idMembers": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "idMembersVoted": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "idShort": 2154,
  "labels": [
    "5abbe4b7ddc1b351ef961414"
  ],
  "limits": {
    "attachments": {
      "perBoard": {
        "status": "ok",
        "disableAt": 36000,
        "warnAt": 32400
      }
    }
  },
  "locationName": "<string>",
  "manualCoverAttachment": false,
  "name": "👋 What? Why? How?",
  "pos": 65535,
  "shortLink": "H0TZyzbK",
  "shortUrl": "https://trello.com/c/H0TZyzbK",
  "subscribed": false,
  "url": "https://trello.com/c/H0TZyzbK/4-%F0%9F%91%8B-what-why-how",
  "cover": {
    "color": "yellow",
    "idUploadedBackground": true,
    "size": "normal",
    "brightness": "light",
    "isTemplate": false
  }
}

GET

Get Actions on a Card

List the Actions on a Card. See Nested Resources for more information.

Request

Path parameters

TrelloID

Required

Query parameters

filter

string

page

number

Responses

Success

application/json

array<Action>

GET/cards/{id}/actions

curl

Node.js

Java

Python

PHP

1
2
3

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

200Response

[
  {
    "id": "5abbe4b7ddc1b351ef961414",
    "idMemberCreator": "5abbe4b7ddc1b351ef961414",
    "data": {
      "text": "Can never go wrong with bowie",
      "card": {
        "id": "5abbe4b7ddc1b351ef961414",
        "name": "Bowie",
        "idShort": 7,
        "shortLink": "3CsPkqOF"
      },
      "board": {
        "id": "5abbe4b7ddc1b351ef961414",
        "name": "Mullets",
        "shortLink": "3CsPkqOF"
      },
      "list": {
        "id": "5abbe4b7ddc1b351ef961414",
        "name": "Amazing"
      }
    },
    "type": "commentCard",
    "date": "2020-03-09T19:41:51.396Z",
    "limits": {
      "reactions": {
        "perAction": {
          "status": "ok",
          "disableAt": 1000,
          "warnAt": 900
        },
        "uniquePerAction": {
          "status": "ok",
          "disableAt": 1000,
          "warnAt": 900
        }
      }
    },
    "display": {
      "translationKey": "action_comment_on_card",
      "entities": {
        "contextOn": {
          "type": "translatable",
          "translationKey": "action_on",
          "hideIfContext": true,
          "idContext": "5abbe4b7ddc1b351ef961414"
        },
        "card": {
          "type": "card",
          "hideIfContext": true,
          "id": "5abbe4b7ddc1b351ef961414",
          "shortLink": "3CsPkqOF",
          "text": "Bowie"
        },
        "comment": {
          "type": "comment",
          "text": "Can never go wrong with bowie"
        },
        "memberCreator": {
          "type": "member",
          "id": "5abbe4b7ddc1b351ef961414",
          "username": "bobloblaw",
          "text": "Bob Loblaw (World)"
        }
      }
    },
    "memberCreator": {
      "id": "5abbe4b7ddc1b351ef961414",
      "activityBlocked": false,
      "avatarHash": "db2adf80c2e6c26b76e1f10400eb4c45",
      "avatarUrl": "https://trello-members.s3.amazonaws.com/5b02e7f4e1facdc393169f9d/db2adf80c2e6c26b76e1f10400eb4c45",
      "fullName": "Bob Loblaw (Trello)",
      "idMemberReferrer": "5abbe4b7ddc1b351ef961414",
      "initials": "BL",
      "username": "bobloblaw"
    }
  }
]

GET

Get Attachments on a Card

List the attachments on a card

Request

Path parameters

TrelloID

Required

Query parameters

fields

string

filter

string

Responses

Success

application/json

array<Attachment>

GET/cards/{id}/attachments

curl

Node.js

Java

Python

PHP

1
2
3

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

200Response

[
  {
    "id": "5abbe4b7ddc1b351ef961414",
    "bytes": "<string>",
    "date": "2018-10-17T19:10:14.808Z",
    "edgeColor": "yellow",
    "idMember": "5abbe4b7ddc1b351ef961414",
    "isUpload": false,
    "mimeType": "",
    "name": "Deprecation Extension Notice",
    "previews": [],
    "url": "https://admin.typeform.com/form/RzExEM/share#/link",
    "pos": 1638
  }
]

POST

Create Attachment On Card

Create an Attachment to a Card. See https://glitch.com/~trello-attachments-api for code examples. You may need to remix the project in order to view it.

Request

Path parameters

TrelloID

Required

Query parameters

name

string

file

string

mimeType

string

url

string

setCover

boolean

Responses

Success

application/json

array<Attachment>

POST/cards/{id}/attachments

curl

Node.js

Java

Python

PHP

1
2
3

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

200Response

[
  {
    "id": "5abbe4b7ddc1b351ef961414",
    "bytes": "<string>",
    "date": "2018-10-17T19:10:14.808Z",
    "edgeColor": "yellow",
    "idMember": "5abbe4b7ddc1b351ef961414",
    "isUpload": false,
    "mimeType": "",
    "name": "Deprecation Extension Notice",
    "previews": [],
    "url": "https://admin.typeform.com/form/RzExEM/share#/link",
    "pos": 1638
  }
]

GET

Get an Attachment on a Card

Get a specific Attachment on a Card.

Request

Path parameters

TrelloID

Required

idAttachment

TrelloID

Required

Query parameters

fields

array<AttachmentFields>

Responses

Success

application/json

array<Attachment>

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

curl

Node.js

Java

Python

PHP

1
2
3

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

200Response

[
  {
    "id": "5abbe4b7ddc1b351ef961414",
    "bytes": "<string>",
    "date": "2018-10-17T19:10:14.808Z",
    "edgeColor": "yellow",
    "idMember": "5abbe4b7ddc1b351ef961414",
    "isUpload": false,
    "mimeType": "",
    "name": "Deprecation Extension Notice",
    "previews": [],
    "url": "https://admin.typeform.com/form/RzExEM/share#/link",
    "pos": 1638
  }
]

DEL

Delete an Attachment on a Card

Delete an Attachment

Request

Path parameters

TrelloID

Required

idAttachment

TrelloID

Required

Responses

Success

DEL/cards/{id}/attachments/{idAttachment}

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get the Board the Card is on

Get the board a card is on

Request

Path parameters

TrelloID

Required

Query parameters

fields

string

Responses

Success

GET/cards/{id}/board

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get checkItems on a Card

Get the completed checklist items on a card

Request

Path parameters

TrelloID

Required

Query parameters

fields

string

Responses

Success

GET/cards/{id}/checkItemStates

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get Checklists on a Card

Get the checklists on a card

Request

Path parameters

TrelloID

Required

Query parameters

checkItems

string

checkItem_fields

string

filter

string

fields

string

Responses

Success

GET/cards/{id}/checklists

curl

Node.js

Java

Python

PHP

1
2

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

POST

Create Checklist on a Card

Create a new checklist on a card

Request

Path parameters

TrelloID

Required

Query parameters

name

string

idChecklistSource

TrelloID

pos

string

Responses

Success

POST/cards/{id}/checklists

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get checkItem on a Card

Get a specific checkItem on a card

Request

Path parameters

TrelloID

Required

idCheckItem

TrelloID

Required

Query parameters

fields

string

Responses

Success

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

curl

Node.js

Java

Python

PHP

1
2

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

PUT

Update a checkItem on a Card

Update an item in a checklist on a card.

Request

Path parameters

TrelloID

Required

idCheckItem

TrelloID

Required

Query parameters

name

string

state

string

idChecklist

TrelloID

pos

oneOf [string, number]

due

string

dueReminder

number

idMember

TrelloID

Responses

Success

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

curl

Node.js

Java

Python

PHP

1
2

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

DEL

Delete checkItem on a Card

Delete a checklist item

Request

Path parameters

TrelloID

Required

idCheckItem

TrelloID

Required

Responses

Success

DEL/cards/{id}/checkItem/{idCheckItem}

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get the List of a Card

Get the list a card is in

Request

Path parameters

TrelloID

Required

Query parameters

fields

string

Responses

Success

GET/cards/{id}/list

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get the Members of a Card

Get the members on a card

Request

Path parameters

TrelloID

Required

Query parameters

fields

string

Responses

Success

GET/cards/{id}/members

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get Members who have voted on a Card

Get the members who have voted on a card

Request

Path parameters

TrelloID

Required

Query parameters

fields

string

Responses

Success

GET/cards/{id}/membersVoted

curl

Node.js

Java

Python

PHP

1
2

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

POST

Add Member vote to Card

Vote on the card for a given member.

Request

Path parameters

TrelloID

Required

Query parameters

value

TrelloID

Required

Responses

Success

POST/cards/{id}/membersVoted

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get pluginData on a Card

Get any shared pluginData on a card.

Request

Path parameters

TrelloID

Required

Responses

Success

GET/cards/{id}/pluginData

curl

Node.js

Java

Python

PHP

1
2

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

GET

Get Stickers on a Card

Get the stickers on a card

Request

Path parameters

TrelloID

Required

Query parameters

fields

string

Responses

Success

GET/cards/{id}/stickers

curl

Node.js

Java

Python

PHP

1
2

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

POST

Add a Sticker to a Card

Add a sticker to a card

Request

Path parameters

TrelloID

Required

Query parameters

image

string

Required

top

number

Required

left

number

Required

zIndex

integer

Required

rotate

number

Responses

Success

POST/cards/{id}/stickers

curl

Node.js

Java

Python

PHP

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'

GET

Get a Sticker on a Card

Get a specific sticker on a card

Request

Path parameters

TrelloID

Required

idSticker

TrelloID

Required

Query parameters

fields

string

Responses

Success

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

curl

Node.js

Java

Python

PHP

1
2

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

PUT

Update a Sticker on a Card

Update a sticker on a card

Request

Path parameters

TrelloID

Required

idSticker

TrelloID

Required

Query parameters

top

number

Required

left

number

Required

zIndex

integer

Required

rotate

number

Responses

Success

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

curl

Node.js

Java

Python

PHP

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'

DEL

Delete a Sticker on a Card

Remove a sticker from the card

Request

Path parameters

TrelloID

Required

idSticker

TrelloID

Required

Responses

Success

DEL/cards/{id}/stickers/{idSticker}

curl

Node.js

Java

Python

PHP

1
2

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

PUT

Update Comment Action on a Card

Update an existing comment

Request

Path parameters

TrelloID

Required

idAction

TrelloID

Required

Query parameters

text

string

Required

Responses

Success

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

curl

Node.js

Java

Python

PHP

1
2

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

DEL

Delete a comment on a Card

Delete a comment

Request

Path parameters

TrelloID

Required

idAction

TrelloID

Required

Responses

Success

DEL/cards/{id}/actions/{idAction}/comments

curl

Node.js

Java

Python

PHP

1
2

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

PUT

Update Custom Field item on Card

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

TrelloID

Required

idCustomField

TrelloID

Required

Request bodyapplication/json

oneOf [object, object]

object

Responses

Success

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

curl

Node.js

Java

Python

PHP

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

PUT

Update Multiple Custom Field items on Card

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

Request

Request bodyapplication/json

customFieldItems

array<object>

Responses

Success

PUT/cards/{idCard}/customFields

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.trello.com/1/cards/{idCard}/customFields?key=APIKey&token=APIToken' \
  --header 'Content-Type: application/json' \
  --data '{
  "customFieldItems": [
    {
      "idCustomField": "5abbe4b7ddc1b351ef961414",
      "value": {
        "text": "<string>",
        "checked": true,
        "date": "2018-03-13T16:00:00.000Z",
        "number": 2154
      },
      "idValue": "5abbe4b7ddc1b351ef961414"
    }
  ]
}'

GET

Get Custom Field Items for a Card

Get the custom field items for a card.

Request

Path parameters

TrelloID

Required

Responses

Success

application/json

array<CustomFieldItems>

GET/cards/{id}/customFieldItems

curl

Node.js

Java

Python

PHP

1
2
3

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

200Response

[
  {
    "id": "5abbe4b7ddc1b351ef961414",
    "value": {
      "checked": "true"
    },
    "idCustomField": "5abbe4b7ddc1b351ef961414",
    "idModel": "5abbe4b7ddc1b351ef961414",
    "modelType": "card"
  }
]

POST

Add a new comment to a Card

Add a new comment to a card

Request

Path parameters

TrelloID

Required

Query parameters

text

string

Required

Responses

Success

application/json

Action

POST/cards/{id}/actions/comments

curl

Node.js

Java

Python

PHP

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'

200Response

{
  "id": "5abbe4b7ddc1b351ef961414",
  "idMemberCreator": "5abbe4b7ddc1b351ef961414",
  "data": {
    "text": "Can never go wrong with bowie",
    "card": {
      "id": "5abbe4b7ddc1b351ef961414",
      "name": "Bowie",
      "idShort": 7,
      "shortLink": "3CsPkqOF"
    },
    "board": {
      "id": "5abbe4b7ddc1b351ef961414",
      "name": "Mullets",
      "shortLink": "3CsPkqOF"
    },
    "list": {
      "id": "5abbe4b7ddc1b351ef961414",
      "name": "Amazing"
    }
  },
  "type": "commentCard",
  "date": "2020-03-09T19:41:51.396Z",
  "limits": {
    "reactions": {
      "perAction": {
        "status": "ok",
        "disableAt": 1000,
        "warnAt": 900
      },
      "uniquePerAction": {
        "status": "ok",
        "disableAt": 1000,
        "warnAt": 900
      }
    }
  },
  "display": {
    "translationKey": "action_comment_on_card",
    "entities": {
      "contextOn": {
        "type": "translatable",
        "translationKey": "action_on",
        "hideIfContext": true,
        "idContext": "5abbe4b7ddc1b351ef961414"
      },
      "card": {
        "type": "card",
        "hideIfContext": true,
        "id": "5abbe4b7ddc1b351ef961414",
        "shortLink": "3CsPkqOF",
        "text": "Bowie"
      },
      "comment": {
        "type": "comment",
        "text": "Can never go wrong with bowie"
      },
      "memberCreator": {
        "type": "member",
        "id": "5abbe4b7ddc1b351ef961414",
        "username": "bobloblaw",
        "text": "Bob Loblaw (World)"
      }
    }
  },
  "memberCreator": {
    "id": "5abbe4b7ddc1b351ef961414",
    "activityBlocked": false,
    "avatarHash": "db2adf80c2e6c26b76e1f10400eb4c45",
    "avatarUrl": "https://trello-members.s3.amazonaws.com/5b02e7f4e1facdc393169f9d/db2adf80c2e6c26b76e1f10400eb4c45",
    "fullName": "Bob Loblaw (Trello)",
    "idMemberReferrer": "5abbe4b7ddc1b351ef961414",
    "initials": "BL",
    "username": "bobloblaw"
  }
}

POST

Add a Label to a Card

Add a label to a card

Request

Path parameters

TrelloID

Required

Query parameters

value

TrelloID

Responses

Success

POST/cards/{id}/idLabels

curl

Node.js

Java

Python

PHP

1
2

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

POST

Add a Member to a Card

Add a member to a card

Request

Path parameters

TrelloID

Required

Query parameters

value

TrelloID

Responses

Success

POST/cards/{id}/idMembers

curl

Node.js

Java

Python

PHP

1
2

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

POST

Create a new Label on a Card

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

Request

Path parameters

TrelloID

Required

Query parameters

color

string

Required

name

string

Responses

Success

POST/cards/{id}/labels

curl

Node.js

Java

Python

PHP

1
2

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

POST

Mark a Card's Notifications as read

Mark notifications about this card as read

Request

Path parameters

TrelloID

Required

Responses

Success

POST/cards/{id}/markAssociatedNotificationsRead

curl

Node.js

Java

Python

PHP

1
2

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

DEL

Remove a Label from a Card

Remove a label from a card

Request

Path parameters

TrelloID

Required

idLabel

TrelloID

Required

Responses

Success

DEL/cards/{id}/idLabels/{idLabel}

curl

Node.js

Java

Python

PHP

1
2

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

DEL

Remove a Member from a Card

Remove a member from a card

Request

Path parameters

TrelloID

Required

idMember

TrelloID

Required

Responses

Success

DEL/cards/{id}/idMembers/{idMember}

curl

Node.js

Java

Python

PHP

1
2

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

DEL

Remove a Member's Vote on a Card

Remove a member's vote from a card

Request

Path parameters

TrelloID

Required

idMember

TrelloID

Required

Responses

Success

DEL/cards/{id}/membersVoted/{idMember}

curl

Node.js

Java

Python

PHP

1
2

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

PUT

Update Checkitem on Checklist on Card

Update an item in a checklist on a card.

Request

Path parameters

idCard

TrelloID

Required

idCheckItem

TrelloID

Required

idChecklist

TrelloID

Required

Query parameters

pos

oneOf [string, number]

Responses

Success

application/json

CheckItem

PUT/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'https://api.trello.com/1/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}?key=APIKey&token=APIToken' \
  --header 'Accept: application/json'

200Response

{
  "idChecklist": "5abbe4b7ddc1b351ef961414",
  "state": "incomplete",
  "id": "5abbe4b7ddc1b351ef961414",
  "name": "<string>",
  "nameData": "<string>",
  "pos": "<string>"
}

DEL

Delete a Checklist on a Card

Delete a checklist from a card

Request

Path parameters

TrelloID

Required

idChecklist

TrelloID

Required

Responses

Success

DEL/cards/{id}/checklists/{idChecklist}

curl

Node.js

Java

Python

PHP

1
2

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