Get information about the memberships users have to the board.
read:board:trelloTrelloID
Requiredstring
boolean
boolean
boolean
MemberFields
Success
1
2
3
4
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/memberships' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
{
"id": "5abbe4b7ddc1b351ef961414"
}Request a single board.
read:board:trelloTrelloID
Requiredstring
string
string
boolean
string
boolean
string
string
string
string
Success
1
2
3
4
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
}Update an existing board by id
read:board:trellowrite:board:trelloTrelloID
Requiredstring
string
boolean
TrelloID
string
string
boolean
boolean
boolean
string
Success
1
2
3
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}' \
--header 'Authorization: Bearer <access_token>'Delete a board.
read:organization:trellowrite:board:trelloTrelloID
RequiredSuccess
1
2
3
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}' \
--header 'Authorization: Bearer <access_token>'Get a single, specific field on a board
read:board:trellostring
Requiredstring
RequiredSuccess
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/{field}' \
--header 'Authorization: Bearer <access_token>'Get all of the actions of a Board. See Nested Resources for more information.
read:board:trellostring
RequiredAction
string
string
string
number
boolean
string
boolean
string
number
Success
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{boardId}/actions' \
--header 'Authorization: Bearer <access_token>'read:board:trellostring
Requiredstring
Success
array<BoardStars>
1
2
3
4
curl --request GET \
--url 'https://api.trello.com/1/boards/{boardId}/boardStars' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
[
{
"id": "5abbe4b7ddc1b351ef961414",
"idBoard": "5abbe4b7ddc1b351ef961414",
"pos": 32768
}
]Get all of the checklists on a Board.
read:board:trellostring
RequiredSuccess
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/checklists' \
--header 'Authorization: Bearer <access_token>'Get all of the open Cards on a Board. See Nested Resources for more information.
read:board:trellostring
RequiredSuccess
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/cards' \
--header 'Authorization: Bearer <access_token>'Get the Cards on a Board that match a given filter. See Nested Resources for more information.
read:board:trellostring
Requiredstring
RequiredSuccess
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/cards/{filter}' \
--header 'Authorization: Bearer <access_token>'Get the Custom Field Definitions that exist on a board.
read:board:trelloTrelloID
RequiredSuccess
array<CustomField>
1
2
3
4
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/customFields' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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 all of the Labels on a Board.
read:board:trelloTrelloID
RequiredLabel
integer
Success
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/labels' \
--header 'Authorization: Bearer <access_token>'Create a new Label on a Board.
write:board:trellostring
Requiredstring
Requiredstring
RequiredSuccess
1
2
3
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/labels?name={name}&color={color}' \
--header 'Authorization: Bearer <access_token>'Get the Lists on a Board
read:board:trelloTrelloID
RequiredViewFilter
string
ViewFilter
string
Success
array<TrelloList>
1
2
3
4
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/lists' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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": {}
}
}
}
]Create a new List on a Board.
write:board:trelloTrelloID
Requiredstring
Requiredstring
Success
1
2
3
4
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/lists?name={name}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
}
}
}
}read:board:trelloTrelloID
RequiredViewFilter
RequiredSuccess
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/lists/{filter}' \
--header 'Authorization: Bearer <access_token>'Get the Members for a board
read:board:trelloTrelloID
RequiredSuccess
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/members' \
--header 'Authorization: Bearer <access_token>'Invite a Member to a Board via their email address.
write:board:membership:trelloTrelloID
Requiredstring
Requiredstring
string
Success
1
2
3
4
5
6
7
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/members?email={email}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"fullName": "<string>"
}'Add a member to the board.
write:board:membership:trelloTrelloID
RequiredTrelloID
Requiredstring
Requiredboolean
Success
1
2
3
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/members/{idMember}?type={type}' \
--header 'Authorization: Bearer <access_token>'write:board:membership:trelloTrelloID
RequiredTrelloID
RequiredSuccess
1
2
3
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}/members/{idMember}' \
--header 'Authorization: Bearer <access_token>'Update an existing board by id
write:board:membership:trelloTrelloID
RequiredTrelloID
Requiredstring
Requiredstring
Success
1
2
3
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/memberships/{idMembership}?type={type}' \
--header 'Authorization: Bearer <access_token>'Update emailPosition Pref on a Board
write:board:trelloTrelloID
Requiredstring
RequiredSuccess
1
2
3
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/emailPosition?value={value}' \
--header 'Authorization: Bearer <access_token>'Change the default list that email-to-board cards are created in.
write:board:trelloTrelloID
RequiredTrelloID
RequiredSuccess
1
2
3
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/idEmailList?value=5abbe4b7ddc1b351ef961414' \
--header 'Authorization: Bearer <access_token>'read:board:trelloTrelloID
Requiredboolean
RequiredSuccess
1
2
3
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebar?value={value}' \
--header 'Authorization: Bearer <access_token>'read:board:trelloTrelloID
Requiredboolean
RequiredSuccess
1
2
3
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarActivity?value={value}' \
--header 'Authorization: Bearer <access_token>'read:board:trelloTrelloID
Requiredboolean
RequiredSuccess
1
2
3
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarBoardActions?value={value}' \
--header 'Authorization: Bearer <access_token>'read:board:trelloTrelloID
Requiredboolean
RequiredSuccess
1
2
3
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarMembers?value={value}' \
--header 'Authorization: Bearer <access_token>'Create a new board.
write:board:trellostring
Requiredboolean
boolean
string
TrelloID
TrelloID
string
string
string
string
Success
1
2
3
curl --request POST \
--url 'https://api.trello.com/1/boards/?name={name}' \
--header 'Authorization: Bearer <access_token>'Create a new board.
write:board:trelloTrelloID
RequiredSuccess
1
2
3
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/calendarKey/generate' \
--header 'Authorization: Bearer <access_token>'write:board:trelloTrelloID
RequiredSuccess
1
2
3
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/emailKey/generate' \
--header 'Authorization: Bearer <access_token>'write:board:trelloTrelloID
RequiredTrelloID
RequiredSuccess
1
2
3
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/idTags?value=5abbe4b7ddc1b351ef961414' \
--header 'Authorization: Bearer <access_token>'read:board:trelloTrelloID
RequiredSuccess
1
2
3
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/markAsViewed' \
--header 'Authorization: Bearer <access_token>'Get the enabled Power-Ups on a board
read:board:trelloTrelloID
RequiredSuccess
array<Plugin>
1
2
3
4
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/boardPlugins' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
[
{
"id": "5abbe4b7ddc1b351ef961414"
}
]Enable a Power-Up on a Board
write:board:trelloTrelloID
RequiredTrelloID
Success
1
2
3
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/boardPlugins' \
--header 'Authorization: Bearer <access_token>'Disable a Power-Up on a board
write:board:trelloTrelloID
RequiredTrelloID
RequiredSuccess
1
2
3
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}/boardPlugins/{idPlugin}' \
--header 'Authorization: Bearer <access_token>'List the Power-Ups on a board
read:board:trelloTrelloID
Requiredstring
Success
1
2
3
4
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/plugins' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
{
"id": "5abbe4b7ddc1b351ef961414"
}Kick off an export of a board. Only one export may be in progress for a board at a time.
write:board:trelloTrelloID
Requiredboolean
number
Success
1
2
3
4
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/exports' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"id": "5abbe4b7ddc1b351ef961414",
"status": {
"attempts": 0,
"finished": false,
"stage": "Export_queued"
},
"startedAt": "2019-11-15T16:55:02.000Z",
"size": "<string>",
"exportUrl": "<string>"
}Get the status of a board export
write:board:trelloTrelloID
RequiredTrelloID
RequiredSuccess
1
2
3
4
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/exports/{idExport}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"id": "5abbe4b7ddc1b351ef961414",
"status": {
"attempts": 0,
"finished": false,
"stage": "Export_queued"
},
"startedAt": "2019-11-15T16:55:02.000Z",
"size": "<string>",
"exportUrl": "<string>"
}Soft-delete a board export
write:board:trelloTrelloID
RequiredTrelloID
RequiredSuccess
1
2
3
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}/exports/{idExport}' \
--header 'Authorization: Bearer <access_token>'Download the exported file. Redirects to the file location if the export is ready, or errors if it is not.
write:board:trelloTrelloID
RequiredTrelloID
RequiredRedirects to the export file's download location
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/exports/{idExport}/download' \
--header 'Authorization: Bearer <access_token>'Get the most recent successful export for a board
write:board:trelloTrelloID
RequiredSuccess
1
2
3
4
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/exports/mostRecent' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"id": "5abbe4b7ddc1b351ef961414",
"status": {
"attempts": 0,
"finished": false,
"stage": "Export_queued"
},
"startedAt": "2019-11-15T16:55:02.000Z",
"size": "<string>",
"exportUrl": "<string>"
}Rate this page: