Rate this page:
POST /1/cards
Create a new card
string
The name for the card
string
The description for the card
oneOf [string, number]
The position of the new card. top
, bottom
, or a positive float
string
A due date for the card
date
string
The start date of a card, or null
true
, Format: date
boolean
string
The ID of the list the card should be created in
^[0-9a-fA-F]{24}$
Array<string>
Comma-separated list of member IDs to add to the card
Array<string>
Comma-separated list of label IDs to add to the card
string
A URL starting with http://
or https://
url
string
binary
string
The mimeType of the attachment. Max length 256
string
The ID of a card to copy into the new card
^[0-9a-fA-F]{24}$
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
form
, Default: all
Valid values: all
, attachments
, checklists
, comments
, customFields
, due
, start
, labels
, members
, start
...(Show more)
string
For use with/by the Map View
string
For use with/by the Map View
string
For use with/by the Map View. Should take the form latitude,longitude
1 2 3
curl --request POST \
--url 'https://api.trello.com/1/cards?idList=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/cards/{id}
Get a card by its ID
string
The ID of the Card
^[0-9a-fA-F]{24}$
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
string
See the Actions Nested Resource
oneOf [string, boolean]
true
, false
, or cover
false
string
all
or a comma-separated list of attachment fields
all
boolean
Whether to return member objects for members on the card
false
string
all
or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username
boolean
Whether to return member objects for members who voted on the card
false
string
all
or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username
boolean
false
string
Whether to return the checklists on the card. all
or none
none
string
all
or a comma-separated list of idBoard,idCard,name,pos
all
boolean
Whether to return the board object the card is on
false
string
all
or a comma-separated list of board fields. Defaults: name, desc, descData, closed, idOrganization, pinned, url, prefs
boolean
See the Lists Nested Resource
false
boolean
Whether to include pluginData on the card with the response
false
boolean
Whether to include sticker models with the response
false
string
all
or a comma-separated list of sticker fields
all
boolean
Whether to include the customFieldItems
false
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
PUT /1/cards/{id}
Update a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The new name for the card
string
The new description for the card
boolean
Whether the card should be archived (closed: true)
string
Comma-separated list of member IDs
form
, Pattern: ^[0-9a-fA-F]{24}$
string
The ID of the image attachment the card should use as its cover, or null for none
^[0-9a-fA-F]{24}$
string
The ID of the list the card should be in
^[0-9a-fA-F]{24}$
string
Comma-separated list of label IDs
form
, Pattern: ^[0-9a-fA-F]{24}$
string
The ID of the board the card should be on
^[0-9a-fA-F]{24}$
oneOf [string, number]
The position of the card in its list. top
, bottom
, or a positive float
string
When the card is due, or null
true
, Format: date
string
The start date of a card, or null
true
, Format: date
boolean
Whether the due date should be marked complete
boolean
Whether the member is should be subscribed to the card
string
For use with/by the Map View
string
For use with/by the Map View
string
For use with/by the Map View. Should be latitude,longitude
Updates the card's cover
Option | Values | About |
---|---|---|
color | pink , yellow , lime , blue , black , orange , red , purple , sky , green | Makes the cover a solid color . |
brightness | dark , light | Determines whether the text on the cover should be dark or light. |
url | An unsplash URL: https://images.unsplash.com | Used if making an image the cover. Only Unsplash URLs work. |
idAttachment | ID of an attachment on the card | Used if setting an attached image as the cover. |
size | normal , full | Determines 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:
1 2 3
curl --request PUT \
--url 'https://api.trello.com/1/cards/{id}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
DELETE /1/cards/{id}
Delete a Card
string
The ID of the Card
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/cards/{id}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/{field}
Get a specific property of a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The desired field.
Valid values: id
, address
, badges
, checkItemStates
, closed
, coordinates
, creationMethod
, dueComplete
, dateLastActivity
, desc
...(Show more)
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/{field}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/cards/{id}/actions
List the Actions on a Card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
A comma-separated list of action types.
commentCard, updateCard:idList
number
The page of results for actions. Each page of results has 50 actions.
0
, Maximum: 19
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/actions?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Action> |
GET /1/cards/{id}/attachments
List the attachments on a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of attachment fields
all
string
Use cover
to restrict to just the cover attachment
false
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/attachments?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Attachment> |
POST /1/cards/{id}/attachments
Create an Attachment to a Card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The name of the attachment. Max length 256.
string
The file to attach, as multipart/form-data
binary
string
The mimeType of the attachment. Max length 256
string
A URL to attach. Must start with http://
or https://
boolean
Determines whether to use the new attachment as a cover for the Card.
false
1 2 3
curl --request POST \
--url 'https://api.trello.com/1/cards/{id}/attachments?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Attachment> |
GET /1/cards/{id}/attachments/{idAttachment}
Get a specific Attachment on a Card.
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the Attachment
^[0-9a-fA-F]{24}$
Array<string>
The Attachment fields to be included in the response.
form
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/attachments/{idAttachment}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Attachment> |
DELETE /1/cards/{id}/attachments/{idAttachment}
Delete an Attachment
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the Attachment
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/cards/{id}/attachments/{idAttachment}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/board
Get the board a card is on
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of board fields
all
1 2
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/board?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/checkItemStates
Get the completed checklist items on a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of: idCheckItem
, state
all
1 2
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/checkItemStates?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/checklists
Get the checklists on a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
all
or none
all
Valid values: all
, none
string
all
or a comma-separated list of: name,nameData,pos,state,type,due,dueReminder,idMember
form
, Default: name,nameData,pos,state,due,dueReminder,idMember
Valid values: name
, nameData
, pos
, state
, type
, due
, dueReminder
, idMember
string
all
or none
all
Valid values: all
, none
string
all
or a comma-separated list of: idBoard,idCard,name,pos
form
, Default: all
Valid values: all
, name
, nameData
, pos
, state
, type
1 2
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/checklists?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
POST /1/cards/{id}/checklists
Create a new checklist on a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The name of the checklist
string
The ID of a source checklist to copy into the new one
^[0-9a-fA-F]{24}$
string
The position of the checklist on the card. One of: top
, bottom
, or a positive number.
1 2
curl --request POST \
--url 'https://api.trello.com/1/cards/{id}/checklists?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/checkItem/{idCheckItem}
Get a specific checkItem on a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the checkitem
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of name,nameData,pos,state,type,due,dueReminder,idMember
name,nameData,pos,state,due,dueReminder,idMember
1 2
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/checkItem/{idCheckItem}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
PUT /1/cards/{id}/checkItem/{idCheckItem}
Update an item in a checklist on a card.
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the checkitem
^[0-9a-fA-F]{24}$
string
The new name for the checklist item
string
One of: complete
, incomplete
Valid values: complete
, incomplete
string
The ID of the checklist this item is in
^[0-9a-fA-F]{24}$
oneOf [string, number]
top
, bottom
, or a positive float
string
A due date for the checkitem
date
number
A dueReminder for the due date on the checkitem
true
string
The ID of the member to remove from the card
^[0-9a-fA-F]{24}$
1 2
curl --request PUT \
--url 'https://api.trello.com/1/cards/{id}/checkItem/{idCheckItem}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/cards/{id}/checkItem/{idCheckItem}
Delete a checklist item
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the checkitem
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/cards/{id}/checkItem/{idCheckItem}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/list
Get the list a card is in
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of list fields
all
1 2
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/list?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/members
Get the members on a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of member fields
avatarHash,fullName,initials,username
1 2
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/members?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/membersVoted
Get the members who have voted on a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of member fields
avatarHash,fullName,initials,username
1 2
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/membersVoted?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
POST /1/cards/{id}/membersVoted
Vote on the card for a given member.
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the member to vote 'yes' on the card
^[0-9a-fA-F]{24}$
1 2
curl --request POST \
--url 'https://api.trello.com/1/cards/{id}/membersVoted?value=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/pluginData
Get any shared pluginData on a card.
string
The ID of the Card
^[0-9a-fA-F]{24}$
1 2
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/pluginData?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/stickers
Get the stickers on a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of sticker fields
all
1 2
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/stickers?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
POST /1/cards/{id}/stickers
Add a sticker to a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
For custom stickers, the id of the sticker. For default stickers, the string identifier (like 'taco-cool', see below)
number
The top position of the sticker, from -60 to 100
-60
, Maximum: 100
, Format: float
number
The left position of the sticker, from -60 to 100
-60
, Maximum: 100
, Format: float
integer
The z-index of the sticker
number
The rotation of the sticker
0
, Minimum: 0
, Maximum: 360
, Format: float
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'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/stickers/{idSticker}
Get a specific sticker on a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the sticker
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of sticker fields
all
1 2
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/stickers/{idSticker}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
PUT /1/cards/{id}/stickers/{idSticker}
Update a sticker on a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the sticker
^[0-9a-fA-F]{24}$
number
The top position of the sticker, from -60 to 100
-60
, Maximum: 100
, Format: float
number
The left position of the sticker, from -60 to 100
-60
, Maximum: 100
, Format: float
integer
The z-index of the sticker
number
The rotation of the sticker
0
, Minimum: 0
, Maximum: 360
, Format: float
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'
Success
A schema has not been defined for this response code.
DELETE /1/cards/{id}/stickers/{idSticker}
Remove a sticker from the card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the sticker
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/cards/{id}/stickers/{idSticker}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
PUT /1/cards/{id}/actions/{idAction}/comments
Update an existing comment
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the comment action to update
^[0-9a-fA-F]{24}$
string
The new text for the comment
1 2
curl --request PUT \
--url 'https://api.trello.com/1/cards/{id}/actions/{idAction}/comments?text={text}&key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/cards/{id}/actions/{idAction}/comments
Delete a comment
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the comment action to update
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/cards/{id}/actions/{idAction}/comments?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
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
string
ID of the card that the Custom Field value should be set/updated for
^[0-9a-fA-F]{24}$
string
ID of the Custom Field on the card.
^[0-9a-fA-F]{24}$
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
}
}'
Success
A schema has not been defined for this response code.
GET /1/cards/{id}/customFieldItems
Get the custom field items for a card.
string
The ID of the Card
^[0-9a-fA-F]{24}$
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/cards/{id}/customFieldItems?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<CustomFieldItems> |
POST /1/cards/{id}/actions/comments
Add a new comment to a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The comment
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'
Success
Content type | Value |
---|---|
application/json |
POST /1/cards/{id}/idLabels
Add a label to a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the label to add
^[0-9a-fA-F]{24}$
1 2
curl --request POST \
--url 'https://api.trello.com/1/cards/{id}/idLabels?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
POST /1/cards/{id}/idMembers
Add a member to a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the Member to add to the card
^[0-9a-fA-F]{24}$
1 2
curl --request POST \
--url 'https://api.trello.com/1/cards/{id}/idMembers?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
POST /1/cards/{id}/labels
Create a new label for the board and add it to the given card.
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
A valid label color or null
. See labels
string
A name for the label
1 2
curl --request POST \
--url 'https://api.trello.com/1/cards/{id}/labels?color={color}&key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
POST /1/cards/{id}/markAssociatedNotificationsRead
Mark notifications about this card as read
string
The ID of the Card
^[0-9a-fA-F]{24}$
1 2
curl --request POST \
--url 'https://api.trello.com/1/cards/{id}/markAssociatedNotificationsRead?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/cards/{id}/idLabels/{idLabel}
Remove a label from a card
string
The ID of the Card
^[0-9a-fA-F]{24}$
string
The ID of the label to remove
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/cards/{id}/idLabels/{idLabel}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/cards/{id}/idMembers/{idMember}
Remove a member from a card