Rate this page:
GET /1/boards/{id}/memberships
Get information about the memberships users have to the board.
string
The ID of the board
^[0-9a-fA-F]{24}$string
One of admins, all, none, normal
allValid values: admins, all, none, normal
boolean
Works for premium organizations only.
falseboolean
Shows the type of member to the org the user is. For instance, an org admin will have a orgMemberType of admin.
falseboolean
Determines whether to include a nested member object.
falsestring
Fields to show if member=true. Valid values: nested member resource fields.
formValid values: id
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/memberships?key=APIKey&token=APIToken' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json |
GET /1/boards/{id}
Request a single board.
string
^[0-9a-fA-F]{24}$string
This is a nested resource. Read more about actions as nested resources here.
allstring
Valid values are one of: mine or none.
nonestring
This is a nested resource. Read more about cards as nested resources here.
noneboolean
Use with the cards param to include card pluginData with the response
falsestring
This is a nested resource. Read more about checklists as nested resources here.
noneboolean
This is a nested resource. Read more about custom fields as nested resources here.
falsestring
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
name,desc,descData,closed,idOrganization,pinned,url,shortUrl,prefs,labelNamesstring
This is a nested resource. Read more about labels as nested resources here.
string
This is a nested resource. Read more about lists as nested resources here.
openstring
This is a nested resource. Read more about members as nested resources here.
nonestring
This is a nested resource. Read more about memberships as nested resources here.
noneboolean
Determines whether the pluginData for this board should be returned. Valid values: true or false.
falseboolean
This is a nested resource. Read more about organizations as nested resources here.
falseboolean
Use with the organization param to include organization pluginData with the response
falseboolean
falseboolean
Also known as collections, tags, refer to the collection(s) that a Board belongs to.
false1 2 3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json |
PUT /1/boards/{id}
Update an existing board by id
string
^[0-9a-fA-F]{24}$string
The new name for the board. 1 to 16384 characters long.
string
A new description for the board, 0 to 16384 characters long
boolean
Whether the board is closed
string
Whether the acting user is subscribed to the board
form, Pattern: ^[0-9a-fA-F]{24}$string
The id of the Workspace the board should be moved to
string
One of: org, private, public
boolean
Whether Workspace members can join the board themselves
boolean
Whether card covers should be displayed on this board
boolean
Determines whether the Voting Power-Up should hide who voted on cards or not.
string
Who can invite people to this board. One of: admins, members
string
Who can vote on this board. One of disabled, members, observers, org, public
string
Who can comment on cards on this board. One of: disabled, members, observers, org, public
string
The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey
string
One of: pirate, regular
boolean
Determines whether the calendar feed is enabled or not.
string
Name for the green label. 1 to 16384 characters long
string
Name for the yellow label. 1 to 16384 characters long
string
Name for the orange label. 1 to 16384 characters long
string
Name for the red label. 1 to 16384 characters long
string
Name for the purple label. 1 to 16384 characters long
string
Name for the blue label. 1 to 16384 characters long
1 2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
DELETE /1/boards/{id}
Delete a board.
string
^[0-9a-fA-F]{24}$1 2
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{id}/{field}
Get a single, specific field on a board
string
The ID of the board.
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.
1 2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/{field}?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{boardId}/actions
string
The fields to be returned for the Actions. See Action fields here.
string
A comma-separated list of action types.
string
The format of the returned Actions. Either list or count.
liststring
A comma-separated list of idModels. Only actions related to these models will be returned.
number
The limit of the number of responses, between 0 and 1000.
50boolean
Whether to return the member object for each action.
truestring
The fields of the member to return.
activityBlocked,avatarHash,avatarUrl,fullName,idMemberReferrer,initials,nonPublic,nonPublicAvailable,usernameboolean
Whether to return the memberCreator object for each action.
truestring
The fields of the member creator to return
activityBlocked,avatarHash,avatarUrl,fullName,idMemberReferrer,initials,nonPublic,nonPublicAvailable,usernamenumber
The page of results for actions.
0boolean
Whether to show reactions on comments or not.
string
An Action ID
string
An Action ID
1 2
curl --request GET \
--url 'https://api.trello.com/1/boards/{boardId}/actions?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{id}/cards/{idCard}
Get a single Card on a Board.
string
The ID of the board
string
The id the card to retrieve.
The fields to be returned for the Actions. See Action fields here.
string
A comma-separated list of action types.
string
The format of the returned Actions. Either list or count.
liststring
A comma-separated list of idModels. Only actions related to these models will be returned.
number
The limit of the number of responses, between 0 and 1000.
50boolean
Whether to return the member object for each action.
truestring
The fields of the member to return.
activityBlocked,avatarHash,avatarUrl,fullName,idMemberReferrer,initials,nonPublic,nonPublicAvailable,usernameboolean
Whether to return the memberCreator object for each action.
truestring
The fields of the member creator to return
activityBlocked,avatarHash,avatarUrl,fullName,idMemberReferrer,initials,nonPublic,nonPublicAvailable,usernamenumber
The page of results for actions.
0boolean
Whether to show reactions on comments or not.
string
An Action ID
string
An Action ID
1 2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/cards/{idCard}?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{boardId}/boardStars
string
string
Valid values: mine, none
mine1 2 3
curl --request GET \
--url 'https://api.trello.com/1/boards/{boardId}/boardStars?key=APIKey&token=APIToken' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json | Array<BoardStars> |
GET /1/boards/{id}/checklists
Get all of the checklists on a Board.
string
The ID of the board
1 2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/checklists?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{id}/cards
Get all of the open Cards on a Board.
string
1 2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/cards?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{id}/cards/{filter}
Get the Cards on a Board that match a given filter.
string
ID of the Board
string
Valid Values: all, closed, none, open, visible.
Valid values: all, closed, none, open, visible
1 2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/cards/{filter}?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{id}/customFields
Get the Custom Field Definitions that exist on a board.
string
The ID of the board
^[0-9a-fA-F]{24}$1 2 3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/customFields?key=APIKey&token=APIToken' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json | Array<CustomField> |
GET /1/boards/{id}/labels
Get all of the Labels on a Board.
string
The ID of the Board.
^[0-9a-fA-F]{24}$The fields to be returned for the Labels.
integer
The number of Labels to be returned.
50, Minimum: 0, Maximum: 1000, Format: int321 2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/labels?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
POST /1/boards/{id}/labels
Create a new Label on a Board.
string
The id of the board to update
string
The name of the label to be created. 1 to 16384 characters long.
string
Sets the color of the new label. Valid values are a label color or null.
1 2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/labels?name={name}&color={color}&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{id}/lists
Get the Lists on a Board
string
The ID of the board
^[0-9a-fA-F]{24}$string
Filter to apply to Cards.
Valid values: all, closed, none, open
string
all or a comma-separated list of card fields
allstring
Filter to apply to Lists
Valid values: all, closed, none, open
string
all or a comma-separated list of list fields
all1 2 3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/lists?key=APIKey&token=APIToken' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json | Array<TrelloList> |
POST /1/boards/{id}/lists
Create a new List on a Board.
string
The ID of the board
^[0-9a-fA-F]{24}$string
The name of the list to be created. 1 to 16384 characters long.
string
Determines the position of the list. Valid values: top, bottom, or a positive number.
top1 2 3
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/lists?name={name}&key=APIKey&token=APIToken' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json |
GET /1/boards/{id}/lists/{filter}
string
The ID of the board
^[0-9a-fA-F]{24}$string
One of all, closed, none, open
Valid values: all, closed, none, open
1 2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/lists/{filter}?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{id}/members
Get the Members for a board
string
The ID of the board
^[0-9a-fA-F]{24}$1 2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/members?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
PUT /1/boards/{id}/members
Invite a Member to a Board via their email address.
string
The ID of the board
^[0-9a-fA-F]{24}$string
The email address of a user to add as a member of the board.
emailstring
Valid values: admin, normal, observer. Determines what type of member the user being added should be of the board.
normalValid values: admin, normal, observer
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.
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>"
}'Success
A schema has not been defined for this response code.
PUT /1/boards/{id}/members/{idMember}
Add a member to the board.
string
The id of the board to update
^[0-9a-fA-F]{24}$string
The id of the member to add to the board.
^[0-9a-fA-F]{24}$string
One of: admin, normal, observer. Determines the type of member this user will be on the board.
Valid values: admin, normal, observer
boolean
Optional param that allows organization admins to add multi-board guests onto a board.
false1 2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/members/{idMember}?type={type}&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
DELETE /1/boards/{id}/members/{idMember}
string
The id of the board to update
^[0-9a-fA-F]{24}$string
The id of the member to add to the board.
^[0-9a-fA-F]{24}$1 2
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}/members/{idMember}?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
PUT /1/boards/{id}/memberships/{idMembership}
Update an existing board by id
string
The id of the board to update
^[0-9a-fA-F]{24}$string
The id of a membership that should be added to this board.
^[0-9a-fA-F]{24}$string
One of: admin, normal, observer. Determines the type of member that this membership will be to this board.
Valid values: admin, normal, observer
string
Valid values: all, avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username
form, Default: fullName, usernameValid values: all, avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products ...(Show more)
1 2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/memberships/{idMembership}?type={type}&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
PUT /1/boards/{id}/myPrefs/emailPosition
Update emailPosition Pref on a Board
string
The id of the board to update
^[0-9a-fA-F]{24}$string
Valid values: bottom, top. Determines the position of the email address.
Valid values: bottom, top
1 2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/emailPosition?value={value}&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
PUT /1/boards/{id}/myPrefs/idEmailList
Change the default list that email-to-board cards are created in.
string
The id of the board to update
^[0-9a-fA-F]{24}$string
The id of an email list.
^[0-9a-fA-F]{24}$1 2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/idEmailList?value=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
PUT /1/boards/{id}/myPrefs/showListGuide
string
The id of the board to update
^[0-9a-fA-F]{24}$boolean
Determines whether to show the list guide.
1 2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showListGuide?value={value}&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
PUT /1/boards/{id}/myPrefs/showSidebar
string
The id of the board to update
^[0-9a-fA-F]{24}$boolean
Determines whether to show the side bar.
1 2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebar?value={value}&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
PUT /1/boards/{id}/myPrefs/showSidebarActivity
string
The id of the board to update
^[0-9a-fA-F]{24}$boolean
Determines whether to show sidebar activity.
1 2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarActivity?value={value}&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
PUT /1/boards/{id}/myPrefs/showSidebarBoardActions
string
The id of the board to update
^[0-9a-fA-F]{24}$boolean
Determines whether to show the sidebar board actions.
1 2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarBoardActions?value={value}&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
PUT /1/boards/{id}/myPrefs/showSidebarMembers
string
The id of the board to update
^[0-9a-fA-F]{24}$boolean
Determines whether to show members of the board in the sidebar.
1 2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarMembers?value={value}&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
POST /1/boards/
Create a new board.
string
The new name for the board. 1 to 16384 characters long.
1, Max length: 16384boolean
Determines whether to use the default set of labels.
trueboolean
Determines whether to add the default set of lists to a board (To Do, Doing, Done). It is ignored if idBoardSource is provided.
truestring
A new description for the board, 0 to 16384 characters long
0, Max length: 16384string
The id or name of the Workspace the board should belong to.
^[0-9a-fA-F]{24}$string
The id of a board to copy into the new board.
^[0-9a-fA-F]{24}$string
To keep cards from the original board pass in the value cards
noneValid values: cards, none
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
string
The permissions level of the board. One of: org, private, public.
privateValid values: org, private, public
string
Who can vote on this board. One of disabled, members, observers, org, public.
disabledValid values: disabled, members, observers, org, public
string
Who can comment on cards on this board. One of: disabled, members, observers, org, public.
membersValid values: disabled, members, observers, org, public
string
Determines what types of members can invite users to join. One of: admins, members.
membersValid values: members, admins
boolean
Determines whether users can join the boards themselves or whether they have to be invited.
trueboolean
Determines whether card covers are enabled.
truestring
The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey.
blueValid values: blue, orange, green, red, purple, pink, lime, sky, grey
string
Determines the type of card aging that should take place on the board if card aging is enabled. One of: pirate, regular.
regularValid values: pirate, regular
1 2
curl --request POST \
--url 'https://api.trello.com/1/boards/?name={name}&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
POST /1/boards/{id}/calendarKey/generate
Create a new board.
string
The id of the board to update
^[0-9a-fA-F]{24}$1 2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/calendarKey/generate?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
POST /1/boards/{id}/emailKey/generate
string
The id of the board to update
^[0-9a-fA-F]{24}$1 2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/emailKey/generate?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
POST /1/boards/{id}/idTags
string
The id of the board to update
^[0-9a-fA-F]{24}$string
The id of a tag from the organization to which this board belongs.
^[0-9a-fA-F]{24}$1 2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/idTags?value=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
POST /1/boards/{id}/markedAsViewed
string
The id of the board to update
^[0-9a-fA-F]{24}$1 2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/markedAsViewed?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{id}/boardPlugins
Get the enabled Power-Ups on a board
string
The ID of the Board
^[0-9a-fA-F]{24}$1 2 3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/boardPlugins?key=APIKey&token=APIToken' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json | Array<Plugin> |
POST /1/boards/{id}/boardPlugins
Enable a Power-Up on a Board
string
The ID of the Board
^[0-9a-fA-F]{24}$string
The ID of the Power-Up to enable
^[0-9a-fA-F]{24}$1 2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/boardPlugins?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
DELETE /1/boards/{id}/boardPlugins/{idPlugin}
Disable a Power-Up on a board
string
The ID of the board
^[0-9a-fA-F]{24}$string
The ID of the Power-Up to disable
^[0-9a-fA-F]{24}$1 2
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}/boardPlugins/{idPlugin}?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/boards/{id}/plugins
List the Power-Ups on a board
string
The ID of the board
^[0-9a-fA-F]{24}$string
One of: enabled or available
enabledValid values: enabled, available