Cloud
    Trello / Reference / REST API

    Rate this page:

    Boards

    Postman Collection
    OpenAPI
    GET

    Get Memberships of a Board

    Get information about the memberships users have to the board.

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    filter

    string

    activity

    boolean

    orgMemberType

    boolean

    member

    boolean

    member_fields

    MemberFields

    Responses

    Success

    application/json

    Memberships
    GET/boards/{id}/memberships
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/boards/{id}/memberships?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 { "id": "5abbe4b7ddc1b351ef961414" }
    GET

    Get a Board

    Request a single board.

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    actions

    string

    boardStars

    string

    cards

    string

    card_pluginData

    boolean

    checklists

    string

    customFields

    boolean

    fields

    string

    labels

    string

    lists

    string

    members

    string

    Responses

    Success

    application/json

    Board
    GET/boards/{id}
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/boards/{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 { "id": "5abbe4b7ddc1b351ef961414", "name": "Trello Platform Changes", "desc": "Track changes to Trello's Platform on this board.", "descData": "<string>", "closed": false, "idMemberCreator": "5abbe4b7ddc1b351ef961414", "idOrganization": "5abbe4b7ddc1b351ef961414", "pinned": false, "url": "https://trello.com/b/dQHqCohZ/trello-platform-changelog", "shortUrl": "https://trello.com/b/dQHqCohZ", "prefs": { "permissionLevel": "org", "hideVotes": true, "voting": "disabled", "comments": "<string>", "selfJoin": true, "cardCovers": true, "isTemplate": true, "cardAging": "pirate", "calendarFeedEnabled": true, "background": "5abbe4b7ddc1b351ef961414", "backgroundImage": "<string>", "backgroundImageScaled": [ { "width": 100, "height": 64, "url": "https://trello-backgrounds.s3.amazonaws.com/SharedBackground/100x64/abc/photo-123.jpg" } ], "backgroundTile": true, "backgroundBrightness": "dark", "backgroundBottomColor": "#1e2e00", "backgroundTopColor": "#ffffff", "canBePublic": true, "canBeEnterprise": true, "canBeOrg": true, "canBePrivate": true, "canInvite": true }, "labelNames": { "green": "Addition", "yellow": "Update", "orange": "Deprecation", "red": "Deletion", "purple": "Power-Ups", "blue": "News", "sky": "Announcement", "lime": "Delight", "pink": "REST API", "black": "Capabilties" }, "limits": { "attachments": { "perBoard": { "status": "ok", "disableAt": 36000, "warnAt": 32400 } } }, "starred": true, "memberships": "<string>", "shortLink": "<string>", "subscribed": true, "powerUps": "<string>", "dateLastActivity": "<string>", "dateLastView": "<string>", "idTags": "<string>", "datePluginDisable": "<string>", "creationMethod": "<string>", "ixUpdate": 2154, "templateGallery": "<string>", "enterpriseOwned": true }
    PUT

    Update a Board

    Update an existing board by id

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    name

    string

    desc

    string

    closed

    boolean

    subscribed

    TrelloID

    idOrganization

    string

    prefs/permissionLevel

    string

    prefs/selfJoin

    boolean

    prefs/cardCovers

    boolean

    prefs/hideVotes

    boolean

    prefs/invitations

    string

    Responses

    Success

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

    Delete a Board

    Delete a board.

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

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

    Get a field on a Board

    Get a single, specific field on a board

    Request

    Path parameters

    id

    string

    Required
    field

    string

    Required

    Responses

    Success

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

    Get Actions of a Board

    Request

    Path parameters

    boardId

    string

    Required

    Query parameters

    fields

    Action

    filter

    string

    format

    string

    idModels

    string

    limit

    number

    member

    boolean

    member_fields

    string

    memberCreator

    boolean

    memberCreator_fields

    string

    page

    number

    Responses

    Success

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

    Get a Card on a Board

    Get a single Card on a Board.

    Request

    Path parameters

    id

    string

    Required
    idCard

    string

    Required

    Query parameters

    fields

    Action

    filter

    string

    format

    string

    idModels

    string

    limit

    number

    member

    boolean

    member_fields

    string

    memberCreator

    boolean

    memberCreator_fields

    string

    page

    number

    Responses

    Success

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

    Get boardStars on a Board

    Request

    Path parameters

    boardId

    string

    Required

    Query parameters

    filter

    string

    Responses

    Success

    application/json

    array<BoardStars>

    GET/boards/{boardId}/boardStars
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/boards/{boardId}/boardStars?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 [ { "id": "5abbe4b7ddc1b351ef961414", "idBoard": "5abbe4b7ddc1b351ef961414", "pos": 32768 } ]
    GET

    Get Checklists on a Board

    Get all of the checklists on a Board.

    Request

    Path parameters

    id

    string

    Required

    Responses

    Success

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

    Get Cards on a Board

    Get all of the open Cards on a Board.

    Request

    Path parameters

    id

    string

    Required

    Responses

    Success

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

    Get filtered Cards on a Board

    Get the Cards on a Board that match a given filter.

    Request

    Path parameters

    id

    string

    Required
    filter

    string

    Required

    Responses

    Success

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

    Get Custom Fields for Board

    Get the Custom Field Definitions that exist on a board.

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

    application/json

    array<CustomField>

    GET/boards/{id}/customFields
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/boards/{id}/customFields?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 [ { "id": "5abbe4b7ddc1b351ef961414", "idModel": "586e8f681d4fe9b06a928307", "modelType": "board", "fieldGroup": "f6177ba6839d6fff0f73922c1cea105e793fda8a1433d466104dacc0b7c56955", "display": { "cardFront": true, "name": "Priority πŸ”", "pos": "98304,", "options": [ { "id": "5abbe4b7ddc1b351ef961414", "idCustomField": "5abbe4b7ddc1b351ef961414", "value": { "text": "High" }, "color": "red", "pos": 16384 } ] }, "type": "list" } ]
    GET

    Get Labels on a Board

    Get all of the Labels on a Board.

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    fields

    Label

    limit

    integer

    Responses

    Success

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

    Create a Label on a Board

    Create a new Label on a Board.

    Request

    Path parameters

    id

    string

    Required

    Query parameters

    name

    string

    Required
    color

    string

    Required

    Responses

    Success

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

    Get Lists on a Board

    Get the Lists on a Board

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    cards

    ViewFilter

    card_fields

    string

    filter

    ViewFilter

    fields

    string

    Responses

    Success

    application/json

    array<TrelloList>

    GET/boards/{id}/lists
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/boards/{id}/lists?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 [ { "id": "5abbe4b7ddc1b351ef961414", "name": "Things to buy today", "closed": true, "pos": 2154, "softLimit": "<string>", "idBoard": "<string>", "subscribed": true, "limits": { "attachments": { "perBoard": {} } } } ]
    POST

    Create a List on a Board

    Create a new List on a Board.

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    name

    string

    Required
    pos

    string

    Responses

    Success

    application/json

    TrelloList
    POST/boards/{id}/lists
    1 2 3 curl --request POST \ --url 'https://api.trello.com/1/boards/{id}/lists?name={name}&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 { "id": "5abbe4b7ddc1b351ef961414", "name": "Things to buy today", "closed": true, "pos": 2154, "softLimit": "<string>", "idBoard": "<string>", "subscribed": true, "limits": { "attachments": { "perBoard": { "status": "ok", "disableAt": 36000, "warnAt": 32400 } } } }
    GET

    Get filtered Lists on a Board

    Request

    Path parameters

    id

    TrelloID

    Required
    filter

    ViewFilter

    Required

    Responses

    Success

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

    Get the Members of a Board

    Get the Members for a board

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

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

    Invite Member to Board via email

    Invite a Member to a Board via their email address.

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    email

    string

    Required
    type

    string

    Request bodyapplication/json

    fullName

    string

    Responses

    Success

    PUT/boards/{id}/members
    1 2 3 4 5 6 curl --request PUT \ --url 'https://api.trello.com/1/boards/{id}/members?email={email}&key=APIKey&token=APIToken' \ --header 'Content-Type: application/json' \ --data '{ "fullName": "<string>" }'
    PUT

    Add a Member to a Board

    Add a member to the board.

    Request

    Path parameters

    id

    TrelloID

    Required
    idMember

    TrelloID

    Required

    Query parameters

    type

    string

    Required
    allowBillableGuest

    boolean

    Responses

    Success

    PUT/boards/{id}/members/{idMember}
    1 2 curl --request PUT \ --url 'https://api.trello.com/1/boards/{id}/members/{idMember}?type={type}&key=APIKey&token=APIToken'
    DEL

    Remove Member from Board

    Request

    Path parameters

    id

    TrelloID

    Required
    idMember

    TrelloID

    Required

    Responses

    Success

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

    Update Membership of Member on a Board

    Update an existing board by id

    Request

    Path parameters

    id

    TrelloID

    Required
    idMembership

    TrelloID

    Required

    Query parameters

    type

    string

    Required
    member_fields

    string

    Responses

    Success

    PUT/boards/{id}/memberships/{idMembership}
    1 2 curl --request PUT \ --url 'https://api.trello.com/1/boards/{id}/memberships/{idMembership}?type={type}&key=APIKey&token=APIToken'
    PUT

    Update emailPosition Pref on a Board

    Update emailPosition Pref on a Board

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    value

    string

    Required

    Responses

    Success

    PUT/boards/{id}/myPrefs/emailPosition
    1 2 curl --request PUT \ --url 'https://api.trello.com/1/boards/{id}/myPrefs/emailPosition?value={value}&key=APIKey&token=APIToken'
    PUT

    Update idEmailList Pref on a Board

    Change the default list that email-to-board cards are created in.

    Request

    Path parameters

    id

    TrelloID