Get information about the memberships users have to the board.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredstring
boolean
boolean
boolean
MemberFields
Success
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/memberships?key=APIKey&token=APIToken' \
--header 'Accept: application/json'1
2
3
{
"id": "5abbe4b7ddc1b351ef961414"
}Request a single board.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredstring
string
string
boolean
string
boolean
string
string
string
string
Success
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}?key=APIKey&token=APIToken' \
--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
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredstring
string
boolean
TrelloID
string
string
boolean
boolean
boolean
string
Success
1
2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}?key=APIKey&token=APIToken'Delete a board.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredSuccess
1
2
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}?key=APIKey&token=APIToken'Get a single, specific field on a board
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredSuccess
1
2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/{field}?key=APIKey&token=APIToken'Get all of the actions of a Board. See Nested Resources for more information.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredAction
string
string
string
number
boolean
string
boolean
string
number
Success
1
2
curl --request GET \
--url 'https://api.trello.com/1/boards/{boardId}/actions?key=APIKey&token=APIToken'Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Success
array<BoardStars>
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{boardId}/boardStars?key=APIKey&token=APIToken' \
--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.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredSuccess
1
2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/checklists?key=APIKey&token=APIToken'Get all of the open Cards on a Board. See Nested Resources for more information.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredSuccess
1
2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/cards?key=APIKey&token=APIToken'Get the Cards on a Board that match a given filter. See Nested Resources for more information.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredSuccess
1
2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/cards/{filter}?key=APIKey&token=APIToken'Get the Custom Field Definitions that exist on a board.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredSuccess
array<CustomField>
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/customFields?key=APIKey&token=APIToken' \
--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.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredLabel
integer
Success
1
2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/labels?key=APIKey&token=APIToken'Create a new Label on a Board.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
RequiredSuccess
1
2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/labels?name={name}&color={color}&key=APIKey&token=APIToken'Get the Lists on a Board
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredViewFilter
string
ViewFilter
string
Success
array<TrelloList>
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/lists?key=APIKey&token=APIToken' \
--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.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredstring
Requiredstring
Success
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'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
}
}
}
}Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredViewFilter
RequiredSuccess
1
2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/lists/{filter}?key=APIKey&token=APIToken'Get the Members for a board
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredSuccess
1
2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/members?key=APIKey&token=APIToken'Invite a Member to a Board via their email address.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredstring
Requiredstring
string
Success
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>"
}'Add a member to the board.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredTrelloID
Requiredstring
Requiredboolean
Success
1
2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/members/{idMember}?type={type}&key=APIKey&token=APIToken'Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredTrelloID
RequiredSuccess
1
2
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}/members/{idMember}?key=APIKey&token=APIToken'Update an existing board by id
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredTrelloID
Requiredstring
Requiredstring
Success
1
2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/memberships/{idMembership}?type={type}&key=APIKey&token=APIToken'Update emailPosition Pref on a Board
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredstring
RequiredSuccess
1
2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/emailPosition?value={value}&key=APIKey&token=APIToken'Change the default list that email-to-board cards are created in.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredTrelloID
RequiredSuccess
1
2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/idEmailList?value=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredboolean
RequiredSuccess
1
2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebar?value={value}&key=APIKey&token=APIToken'Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredboolean
RequiredSuccess
1
2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarActivity?value={value}&key=APIKey&token=APIToken'Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredboolean
RequiredSuccess
1
2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarBoardActions?value={value}&key=APIKey&token=APIToken'Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredboolean
RequiredSuccess
1
2
curl --request PUT \
--url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarMembers?value={value}&key=APIKey&token=APIToken'Create a new board.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredboolean
boolean
string
TrelloID
TrelloID
string
string
string
string
Success
1
2
curl --request POST \
--url 'https://api.trello.com/1/boards/?name={name}&key=APIKey&token=APIToken'Create a new board.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredSuccess
1
2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/calendarKey/generate?key=APIKey&token=APIToken'Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredSuccess
1
2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/emailKey/generate?key=APIKey&token=APIToken'Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredTrelloID
RequiredSuccess
1
2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/idTags?value=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken'Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredSuccess
1
2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/markedAsViewed?key=APIKey&token=APIToken'Get the enabled Power-Ups on a board
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredSuccess
array<Plugin>
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/boardPlugins?key=APIKey&token=APIToken' \
--header 'Accept: application/json'1
2
3
4
5
[
{
"id": "5abbe4b7ddc1b351ef961414"
}
]Enable a Power-Up on a Board
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredTrelloID
Success
1
2
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/boardPlugins?key=APIKey&token=APIToken'Disable a Power-Up on a board
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredTrelloID
RequiredSuccess
1
2
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}/boardPlugins/{idPlugin}?key=APIKey&token=APIToken'List the Power-Ups on a board
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredstring
Success
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/plugins?key=APIKey&token=APIToken' \
--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.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
Requiredboolean
number
Success
1
2
3
curl --request POST \
--url 'https://api.trello.com/1/boards/{id}/exports?key=APIKey&token=APIToken' \
--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
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredTrelloID
RequiredSuccess
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/exports/{idExport}?key=APIKey&token=APIToken' \
--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
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredTrelloID
RequiredSuccess
1
2
curl --request DELETE \
--url 'https://api.trello.com/1/boards/{id}/exports/{idExport}?key=APIKey&token=APIToken'Download the exported file. Redirects to the file location if the export is ready, or errors if it is not.
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredTrelloID
RequiredRedirects to the export file's download location
1
2
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/exports/{idExport}/download?key=APIKey&token=APIToken'Get the most recent successful export for a board
Forge and OAuth2 apps cannot access this REST resource.
TrelloID
RequiredSuccess
1
2
3
curl --request GET \
--url 'https://api.trello.com/1/boards/{id}/exports/mostRecent?key=APIKey&token=APIToken' \
--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: