• Actions
    • Applications
    • Batch
    • Boards
    • Cards
    • Checklists
    • CustomFields
    • Emoji
    • Enterprises
    • Labels
    • Lists
    • Members
    • Notifications
    • Organizations
    • Plugins
    • Tokens
    • Webhooks
    Cloud
    Trello / Reference / REST API

    Rate this page:

    Cards

    Postman Collection
    OpenAPI
    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
    1 2 3 curl --request POST \ --url 'https://api.trello.com/1/cards?idList=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 { "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>", "email": "bentleycook+2kea95u7kchsvqnxkwe+2q0byi6qv4pt9uc7q5m+25qyyohtzg@boards.trello.com", "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

    id

    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}
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/cards/{id}?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 { "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>", "email": "bentleycook+2kea95u7kchsvqnxkwe+2q0byi6qv4pt9uc7q5m+25qyyohtzg@boards.trello.com", "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

    id

    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}
    1 2 3 curl --request PUT \ --url 'https://api.trello.com/1/cards/{id}?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 { "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>", "email": "bentleycook+2kea95u7kchsvqnxkwe+2q0byi6qv4pt9uc7q5m+25qyyohtzg@boards.trello.com", "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

    Delete a Card

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

    DEL/cards/{id}
    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

    id

    TrelloID

    Required
    field

    CardFields

    Required

    Responses

    Success

    application/json

    Card
    GET/cards/{id}/{field}
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/cards/{id}/{field}?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 { "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>", "email": "bentleycook+2kea95u7kchsvqnxkwe+2q0byi6qv4pt9uc7q5m+25qyyohtzg@boards.trello.com", "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

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    filter

    string

    page

    number

    Responses

    Success

    application/json

    array<Action>

    GET/cards/{id}/actions
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/cards/{id}/actions?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 [ { "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

    id

    TrelloID

    Required

    Query parameters

    fields

    string

    filter

    string

    Responses

    Success

    application/json

    array<Attachment>

    GET/cards/{id}/attachments
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/cards/{id}/attachments?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 [ { "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

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    name

    string

    file

    string

    mimeType

    string

    url

    string

    setCover

    boolean

    Responses

    Success

    application/json

    array<Attachment>

    POST/cards/{id}/attachments
    1 2 3 curl --request POST \ --url 'https://api.trello.com/1/cards/{id}/attachments?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 [ { "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

    id

    TrelloID

    Required
    idAttachment

    TrelloID

    Required

    Query parameters

    fields

    array<AttachmentFields>

    Responses

    Success

    application/json

    array<Attachment>

    GET/cards/{id}/attachments/{idAttachment}
    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
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 [ { "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

    id

    TrelloID

    Required
    idAttachment

    TrelloID

    Required

    Responses

    Success

    DEL/cards/{id}/attachments/{idAttachment}
    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

    id

    TrelloID

    Required

    Query parameters

    fields

    string

    Responses

    Success

    GET/cards/{id}/board
    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

    id

    TrelloID

    Required

    Query parameters

    fields

    string

    Responses

    Success

    GET/cards/{id}/checkItemStates
    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

    id

    TrelloID

    Required

    Query parameters

    checkItems

    string

    checkItem_fields

    string

    filter

    string

    fields

    string

    Responses

    Success

    GET/cards/{id}/checklists
    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

    id

    TrelloID

    Required

    Query parameters

    name

    string

    idChecklistSource

    TrelloID

    pos

    string

    Responses

    Success

    POST/cards/{id}/checklists
    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

    id

    TrelloID

    Required
    idCheckItem

    TrelloID

    Required

    Query parameters

    fields

    string

    Responses

    Success

    GET/cards/{id}/checkItem/{idCheckItem}
    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

    id

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

    id

    TrelloID

    Required
    idCheckItem

    TrelloID

    Required

    Responses

    Success

    DEL/cards/{id}/checkItem/{idCheckItem}
    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

    id

    TrelloID

    Required

    Query parameters

    fields

    string

    Responses

    Success

    GET/cards/{id}/list
    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

    id

    TrelloID

    Required

    Query parameters

    fields

    string

    Responses

    Success

    GET/cards/{id}/members
    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

    id

    TrelloID

    Required

    Query parameters

    fields

    string

    Responses

    Success

    GET/cards/{id}/membersVoted
    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

    id

    TrelloID

    Required

    Query parameters

    value

    TrelloID

    Required

    Responses

    Success

    POST/cards/{id}/membersVoted
    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

    id

    TrelloID

    Required

    Responses

    Success

    GET/cards/{id}/pluginData
    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

    id

    TrelloID