Rate this page:

    Boards

    Get Memberships of a Board

    GET /1/boards/{id}/memberships

    Get information about the memberships users have to the board.

    Request

    Path parameters
    id Required

    string

    The ID of the board

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    One of admins, all, none, normal

    Default: all

    Valid values: admins, all, none, normal

    activity

    boolean

    Works for premium organizations only.

    Default: false
    orgMemberType

    boolean

    Shows the type of member to the org the user is. For instance, an org admin will have a orgMemberType of admin.

    Default: false
    member

    boolean

    Determines whether to include a nested member object.

    Default: false
    member_fields

    string

    Fields to show if member=true. Valid values: nested member resource fields.

    Style: form

    Valid values: id

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/memberships?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Memberships

    Get a Board

    GET /1/boards/{id}

    Request a single board.

    Request

    Path parameters
    id Required

    string

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    This is a nested resource. Read more about actions as nested resources here.

    Default: all
    boardStars

    string

    Valid values are one of: mine or none.

    Default: none
    cards

    string

    This is a nested resource. Read more about cards as nested resources here.

    Default: none
    card_pluginData

    boolean

    Use with the cards param to include card pluginData with the response

    Default: false
    checklists

    string

    This is a nested resource. Read more about checklists as nested resources here.

    Default: none
    customFields

    boolean

    This is a nested resource. Read more about custom fields as nested resources here.

    Default: false
    fields

    string

    The fields of the board to be included in the response. Valid values: all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idMemberCreator, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url

    Default: name,desc,descData,closed,idOrganization,pinned,url,shortUrl,prefs,labelNames
    labels

    string

    This is a nested resource. Read more about labels as nested resources here.

    lists

    string

    This is a nested resource. Read more about lists as nested resources here.

    Default: open
    members

    string

    This is a nested resource. Read more about members as nested resources here.

    Default: none
    memberships

    string

    This is a nested resource. Read more about memberships as nested resources here.

    Default: none
    pluginData

    boolean

    Determines whether the pluginData for this board should be returned. Valid values: true or false.

    Default: false
    organization

    boolean

    This is a nested resource. Read more about organizations as nested resources here.

    Default: false
    organization_pluginData

    boolean

    Use with the organization param to include organization pluginData with the response

    Default: false
    myPrefs

    boolean

    Default: false
    tags

    boolean

    Also known as collections, tags, refer to the collection(s) that a Board belongs to.

    Default: false

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Board

    Update a Board

    PUT /1/boards/{id}

    Update an existing board by id

    Request

    Path parameters
    id Required

    string

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    The new name for the board. 1 to 16384 characters long.

    desc

    string

    A new description for the board, 0 to 16384 characters long

    closed

    boolean

    Whether the board is closed

    subscribed

    string

    Whether the acting user is subscribed to the board

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

    string

    The id of the Workspace the board should be moved to

    prefs/permissionLevel

    string

    One of: org, private, public

    prefs/selfJoin

    boolean

    Whether Workspace members can join the board themselves

    prefs/cardCovers

    boolean

    Whether card covers should be displayed on this board

    prefs/hideVotes

    boolean

    Determines whether the Voting Power-Up should hide who voted on cards or not.

    prefs/invitations

    string

    Who can invite people to this board. One of: admins, members

    prefs/voting

    string

    Who can vote on this board. One of disabled, members, observers, org, public

    prefs/comments

    string

    Who can comment on cards on this board. One of: disabled, members, observers, org, public

    prefs/background

    string

    The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey

    prefs/cardAging

    string

    One of: pirate, regular

    prefs/calendarFeedEnabled

    boolean

    Determines whether the calendar feed is enabled or not.

    labelNames/green

    string

    Name for the green label. 1 to 16384 characters long

    labelNames/yellow

    string

    Name for the yellow label. 1 to 16384 characters long

    labelNames/orange

    string

    Name for the orange label. 1 to 16384 characters long

    labelNames/red

    string

    Name for the red label. 1 to 16384 characters long

    labelNames/purple

    string

    Name for the purple label. 1 to 16384 characters long

    labelNames/blue

    string

    Name for the blue label. 1 to 16384 characters long

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Delete a Board

    DELETE /1/boards/{id}

    Delete a board.

    Request

    Path parameters
    id Required

    string

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
    curl --request DELETE \
  --url 'https://api.trello.com/1/boards/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Get a field on a Board

    GET /1/boards/{id}/{field}

    Get a single, specific field on a board

    Request

    Path parameters
    id Required

    string

    The ID of the board.

    field Required

    string

    The field you'd like to receive. Valid values: closed, dateLastActivity, dateLastView, desc, descData, idMemberCreator, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url.

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get Actions of a Board

    GET /1/boards/{boardId}/actions

    Request

    Path parameters
    boardId Required

    string

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    A comma-separated list of action types.

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get a Card on a Board

    GET /1/boards/{id}/cards/{idCard}

    Get a single Card on a Board.

    Request

    Path parameters
    id Required

    string

    The ID of the board

    idCard Required

    string

    The id the card to retrieve.

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get boardStars on a Board

    GET /1/boards/{boardId}/boardStars

    Request

    Path parameters
    boardId Required

    string

    filter Required

    string

    Valid values: mine, none

    Default: mine
    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/boards/{boardId}/boardStars?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Array<BoardStars>

    Get Checklists on a Board

    GET /1/boards/{id}/checklists

    Get all of the checklists on a Board.

    Request

    Path parameters
    id Required

    string

    The ID of the board

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Create Checklist on a Board

    POST /1/boards/{id}/checklists

    Create a new checklist on a board.

    Request

    Path parameters
    id Required

    string

    The id of the board to update

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    name Required

    string

    The name of the checklist to be created. 1 to 16384 characters long.

    Example

    1
2
    curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/checklists?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&name={name}'

    Responses

    Success

    A schema has not been defined for this response code.

    Get Cards on a Board

    GET /1/boards/{id}/cards

    Get all of the open Cards on a Board.

    Request

    Path parameters
    id Required

    string

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get filtered Cards on a Board

    GET /1/boards/{id}/cards/{filter}

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

    Request

    Path parameters
    id Required

    string

    ID of the Board

    filter Required

    string

    Valid Values: all, closed, none, open, visible.

    Valid values: all, closed, none, open, visible

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get Custom Fields for Board

    GET /1/boards/{id}/customFields

    Get the Custom Field Definitions that exist on a board.

    Request

    Path parameters
    id Required

    string

    The ID of the board

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/customFields?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Array<CustomField>

    Get Labels on a Board

    GET /1/boards/{id}/labels

    Get all of the Labels on a Board.

    Request

    Path parameters
    id Required

    string

    The ID of the Board.

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Label

    The fields to be returned for the Labels.

    limit

    integer

    The number of Labels to be returned.

    Default: 50, Minimum: 0, Maximum: 1000, Format: int32

    Example

    1
2
    curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/labels?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Create a Label on a Board

    POST /1/boards/{id}/labels

    Create a new Label on a Board.

    Request

    Path parameters
    id Required

    string

    The id of the board to update

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    name Required

    string

    The name of the label to be created. 1 to 16384 characters long.

    color Required

    string

    Sets the color of the new label. Valid values are a label color or null.

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get Lists on a Board

    GET /1/boards/{id}/lists

    Get the Lists on a Board

    Request

    Path parameters
    id Required

    string

    The ID of the board

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    Filter to apply to Cards.

    Valid values: all, closed, none, open

    card_fields

    string

    all or a comma-separated list of card fields

    Default: all
    filter

    string

    Filter to apply to Lists

    Valid values: all, closed, none, open

    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/boards/{id}/lists?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Create a List on a Board

    POST /1/boards/{id}/lists

    Create a new List on a Board.

    Request

    Path parameters
    id Required

    string

    The ID of the board

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    name Required

    string

    The name of the list to be created. 1 to 16384 characters long.

    pos

    string

    Determines the position of the list. Valid values: top, bottom, or a positive number.

    Default: top

    Example

    1
2
    curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/lists?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&name={name}'

    Responses

    Success

    A schema has not been defined for this response code.

    Get filtered Lists on a Board

    GET /1/boards/{id}/lists/{filter}

    Request

    Path parameters
    id Required

    string

    The ID of the board

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

    string

    One of all, closed, none, open

    Valid values: all, closed, none, open

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Get the Members of a Board

    GET /1/boards/{id}/members

    Get the Members for a board

    Request

    Path parameters
    id Required

    string

    The ID of the board

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
    curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/members'

    Responses

    Success

    A schema has not been defined for this response code.

    Invite Member to Board via email

    PUT /1/boards/{id}/members

    Invite a Member to a Board via their email address.

    Request

    Path parameters
    id Required

    string

    The ID of the board

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    email Required

    string

    The email address of a user to add as a member of the board.

    Format: email
    type

    string

    Valid values: admin, normal, observer. Determines what type of member the user being added should be of the board.

    Default: normal

    Valid values: admin, normal, observer

    Body parameters
    fullName

    string

    The full name of the user to as a member of the board. Must have a length of at least 1 and cannot begin nor end with a space.

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/members?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&email={email}'

    Responses

    Success

    A schema has not been defined for this response code.

    Add a Member to a Board

    PUT /1/boards/{id}/members/{idMember}

    Add a member to the board.

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The id of the member to add to the board.

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    type Required

    string

    One of: admin, normal, observer. Determines the type of member this user will be on the board.

    Valid values: admin, normal, observer

    allowBillableGuest

    boolean

    Optional param that allows organization admins to add multi-board guests onto a board.

    Default: false

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Remove Member from Board

    DELETE /1/boards/{id}/members/{idMember}

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The id of the member to add to the board.

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
    curl --request DELETE \
  --url 'https://api.trello.com/1/boards/{id}/members/{idMember}'

    Responses

    Success

    A schema has not been defined for this response code.

    Update Membership of Member on a Board

    PUT /1/boards/{id}/memberships/{idMembership}

    Update an existing board by id

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The id of a membership that should be added to this board.

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    type Required

    string

    One of: admin, normal, observer. Determines the type of member that this membership will be to this board.

    Valid values: admin, normal, observer

    member_fields

    string

    Valid values: all, avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username

    Style: form, Default: fullName, username

    Valid values: all, avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products ...(Show more)

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Update emailPosition Pref on a Board

    PUT /1/boards/{id}/myPrefs/emailPosition

    Update emailPosition Pref on a Board

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    Valid values: bottom, top. Determines the position of the email address.

    Valid values: bottom, top

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Update idEmailList Pref on a Board

    PUT /1/boards/{id}/myPrefs/idEmailList

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

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    The id of an email list.

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

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/idEmailList?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value=5abbe4b7ddc1b351ef961414'

    Responses

    Success

    A schema has not been defined for this response code.

    Update showListGuide Pref on a Board

    PUT /1/boards/{id}/myPrefs/showListGuide

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    boolean

    Determines whether to show the list guide.

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/showListGuide?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value={value}'

    Responses

    Success

    A schema has not been defined for this response code.

    Update showSidebar Pref on a Board

    PUT /1/boards/{id}/myPrefs/showSidebar

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    boolean

    Determines whether to show the side bar.

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebar?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value={value}'

    Responses

    Success

    A schema has not been defined for this response code.

    Update showSidebarActivity Pref on a Board

    PUT /1/boards/{id}/myPrefs/showSidebarActivity

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    boolean

    Determines whether to show sidebar activity.

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarActivity?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value={value}'

    Responses

    Success

    A schema has not been defined for this response code.

    Update showSidebarBoardActions Pref on a Board

    PUT /1/boards/{id}/myPrefs/showSidebarBoardActions

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    boolean

    Determines whether to show the sidebar board actions.

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarBoardActions?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value={value}'

    Responses

    Success

    A schema has not been defined for this response code.

    Update showSidebarMembers Pref on a Board

    PUT /1/boards/{id}/myPrefs/showSidebarMembers

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    boolean

    Determines whether to show members of the board in the sidebar.

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarMembers?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value={value}'

    Responses

    Success

    A schema has not been defined for this response code.

    Create a Board

    POST /1/boards/

    Create a new board.

    Request

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

    Pattern: ^[0-9a-fA-F]{64}$
    name Required

    string

    The new name for the board. 1 to 16384 characters long.

    Min length: 1, Max length: 16384
    defaultLabels

    boolean

    Determines whether to use the default set of labels.

    Default: true
    defaultLists

    boolean

    Determines whether to add the default set of lists to a board (To Do, Doing, Done). It is ignored if idBoardSource is provided.

    Default: true
    desc

    string

    A new description for the board, 0 to 16384 characters long

    Min length: 0, Max length: 16384
    idOrganization

    string

    The id or name of the Workspace the board should belong to.

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

    string

    The id of a board to copy into the new board.

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

    string

    To keep cards from the original board pass in the value cards

    Default: none

    Valid values: cards, none

    powerUps

    string

    The Power-Ups that should be enabled on the new board. One of: all, calendar, cardAging, recap, voting.

    Valid values: all, calendar, cardAging, recap, voting

    prefs_permissionLevel

    string

    The permissions level of the board. One of: org, private, public.

    Default: private

    Valid values: org, private, public

    prefs_voting

    string

    Who can vote on this board. One of disabled, members, observers, org, public.

    Default: disabled

    Valid values: disabled, members, observers, org, public

    prefs_comments

    string

    Who can comment on cards on this board. One of: disabled, members, observers, org, public.

    Default: members

    Valid values: disabled, members, observers, org, public

    prefs_invitations

    string

    Determines what types of members can invite users to join. One of: admins, members.

    Default: members

    Valid values: members, admins

    prefs_selfJoin

    boolean

    Determines whether users can join the boards themselves or whether they have to be invited.

    Default: true
    prefs_cardCovers

    boolean

    Determines whether card covers are enabled.

    Default: true
    prefs_background

    string

    The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey.

    Default: blue

    Valid values: blue, orange, green, red, purple, pink, lime, sky, grey

    prefs_cardAging

    string

    Determines the type of card aging that should take place on the board if card aging is enabled. One of: pirate, regular.

    Default: regular

    Valid values: pirate, regular

    Example

    1
2
    curl --request POST \
  --url 'https://api.trello.com/1/boards/?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&name={name}'

    Responses

    Success

    A schema has not been defined for this response code.

    Create a calendarKey for a Board

    POST /1/boards/{id}/calendarKey/generate

    Create a new board.

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
    curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/calendarKey/generate?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Create a emailKey for a Board

    POST /1/boards/{id}/emailKey/generate

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
    curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/emailKey/generate?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Create a Tag for a Board

    POST /1/boards/{id}/idTags

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    The id of a tag from the organization to which this board belongs.

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

    Example

    1
2
    curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/idTags?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value=5abbe4b7ddc1b351ef961414'

    Responses

    Success

    A schema has not been defined for this response code.

    Mark Board as viewed

    POST /1/boards/{id}/markedAsViewed

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
    curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/markedAsViewed?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Enable Power-Up on a Board

    POST /1/boards/{id}/powerUps

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    The Power-Up to be enabled on the board. One of: calendar, cardAging, recap, voting.

    Valid values: calendar, cardAging, recap, voting

    Example

    1
2
    curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/powerUps?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value={value}'

    Responses

    Success

    A schema has not been defined for this response code.

    Disable Power-Up on a Board

    DELETE /1/boards/{id}/powerUps/{powerUp}

    Request

    Path parameters
    id Required

    string

    The id of the board to update

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

    string

    The Power-Up to be enabled on the board. One of: calendar, cardAging, recap, voting.

    Valid values: calendar, cardAging, recap, voting

    Query parameters
    key Required

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
    curl --request DELETE \
  --url 'https://api.trello.com/1/boards/{id}/powerUps/{powerUp}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Get Enabled Power-Ups on Board

    GET /1/boards/{id}/boardPlugins

    Get the enabled Power-Ups on a board

    Request

    Path parameters
    id Required

    string

    The ID of the Board

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/boardPlugins' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Array<Plugin>

    Enable a Power-Up on a Board

    POST /1/boards/{id}/boardPlugins

    Enable a Power-Up on a Board

    Request

    Path parameters
    id Required

    string

    The ID of the Board

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    The ID of the Power-Up to enable

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

    Example

    1
2
    curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/boardPlugins?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Disable a Power-Up on a Board

    DELETE /1/boards/{id}/boardPlugins/{idPlugin}

    Disable a Power-Up on a board

    Request

    Path parameters
    id Required

    string

    The ID of the board

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

    string

    The ID of the Power-Up to disable

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    Example

    1
2
    curl --request DELETE \
  --url 'https://api.trello.com/1/boards/{id}/boardPlugins/{idPlugin}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

    Responses

    Success

    A schema has not been defined for this response code.

    Get Power-Ups on a Board

    GET /1/boards/{id}/plugins

    List the Power-Ups on a board

    Request

    Path parameters
    id Required

    string

    The ID of the board

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

    string

    The API key to use

    Pattern: ^[0-9a-fA-F]{32}$
    token Required

    string

    The API token to use

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

    string

    One of: enabled or available

    Default: enabled

    Valid values: enabled, available

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/plugins?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Plugin

    Rate this page: