Version 1
Connector Overview: This page documents all 259 actions for the Trelloconnector v1.
General (259)
POST Add Member vote to Card
/cards/{id}/membersVoted
Vote on the card for a given member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the member to vote 'yes' on the card |
|
|
N/A |
POST Add Option to Custom Field dropdown
/customFields/{id}/options
Add an option to a dropdown Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the customfield. |
|
|
N/A |
POST Add a Label to a Card
/cards/{id}/idLabels
Add a label to a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the label to add |
|
|
N/A |
PUT Add a Member to a Board
/boards/{id}/members/{idMember}
Add a member to the board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
The id of the member to add to the board. |
|
|
One of: admin, normal, observer. Determines the type of member this user will be on the board. |
|
|
Optional param that allows organization admins to add multi-board guests onto a board. |
|
|
N/A |
POST Add a Member to a Card
/cards/{id}/idMembers
Add a member to a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the Member to add to the card |
|
|
N/A |
POST Add a Sticker to a Card
/cards/{id}/stickers
Add a sticker to a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
For custom stickers, the id of the sticker. For default stickers, the string identifier (like 'taco-cool', see below) |
|
|
The top position of the sticker, from -60 to 100 |
|
|
The left position of the sticker, from -60 to 100 |
|
|
The z-index of the sticker |
|
|
The rotation of the sticker |
|
|
N/A |
POST Add a new comment to a Card
/cards/{id}/actions/comments
Add a new comment to a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The comment |
|
|
N/A |
POST Archive all Cards in List
/lists/{id}/archiveAllCards
Archive all cards in a list
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the list |
|
|
N/A |
PUT Archive or unarchive a list
/lists/{id}/closed
Archive or unarchive a list
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the list |
|
|
Set to true to close (archive) the list |
|
|
N/A |
GET Batch Requests
/batch
Make up to 10 GET requests in a single, batched API call.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A list of API routes. Maximum of 10 routes allowed. The routes should begin with a forward slash and should not include the API version number - e.g. "urls=/members/trello,/cards/[cardId]" |
|
|
N/A |
GET Bulk accept a set of organizations to an Enterprise.
/enterprises/{id}/organizations/bulk/{idOrganizations}
Accept an array of organizations to an enterprise.
NOTE: For enterprises that have opted in to user management via AdminHub, this endpoint will result in organizations being added to the enterprise asynchronously. A 200 response only indicates receipt of the request, it does not indicate successful addition to the enterprise.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
An array of IDs of the organizations to be removed from the enterprise. |
|
|
N/A |
POST Create Attachment On Card
/cards/{id}/attachments
Create an Attachment to a Card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The name of the attachment. Max length 256. |
|
|
The file to attach, as multipart/form-data |
|
|
The mimeType of the attachment. Max length 256 |
|
|
A URL to attach. Must start with http:// or https:// |
|
|
Determines whether to use the new attachment as a cover for the Card. |
|
|
N/A |
POST Create Avatar for Member
/members/{id}/avatar
Create a new avatar for a member
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
|
|
N/A |
POST Create Checkitem on Checklist
/checklists/{id}/checkItems
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
The name of the new check item on the checklist. Should be a string of length 1 to 16384. |
|
|
The position of the check item in the checklist. One of: top, bottom, or a positive number. |
|
|
Determines whether the check item is already checked when created. |
|
|
A due date for the checkitem |
|
|
A dueReminder for the due date on the checkitem |
|
|
An ID of a member resource. |
|
|
N/A |
POST Create Checklist on a Card
/cards/{id}/checklists
Create a new checklist on a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The name of the checklist |
|
|
The ID of a source checklist to copy into the new one |
|
|
The position of the checklist on the card. One of: top, bottom, or a positive number. |
|
|
N/A |
POST Create Export for Organizations
/organizations/{id}/exports
Kick off CSV export for an organization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the Workspace |
|
|
Whether the CSV should include attachments or not. |
|
|
N/A |
POST Create Reaction for Action
/actions/{idAction}/reactions
Adds a new reaction to an action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the action |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The primary shortName of the emoji to add. See /emoji |
|
|
The skinVariation of the emoji to add. See /emoji |
|
|
The emoji to add as a native unicode emoji. See /emoji |
|
|
The unified value of the emoji to add. See /emoji |
POST Create Star for Board
/members/{id}/boardStars
Star a new board on behalf of a Member
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the board to star |
|
|
The position of the newly starred board. top, bottom, or a positive float. |
|
|
N/A |
POST Create Webhooks for Token
/tokens/{token}/webhooks
Create a new webhook for a Token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A description to be displayed when retrieving information about the webhook. |
|
|
The URL that the webhook should POST information to. |
|
|
ID of the object to create a webhook on. |
|
|
N/A |
POST Create a Board
/boards/
Create a new board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The new name for the board. 1 to 16384 characters long. |
|
|
Determines whether to use the default set of labels. |
|
|
Determines whether to add the default set of lists to a board (To Do, Doing, Done). It is ignored if idBoardSource is provided. |
|
|
A new description for the board, 0 to 16384 characters long |
|
|
The id or name of the Workspace the board should belong to. |
|
|
The id of a board to copy into the new board. |
|
|
To keep cards from the original board pass in the value cards |
|
|
The Power-Ups that should be enabled on the new board. One of: all, calendar, cardAging, recap, voting. |
|
|
The permissions level of the board. One of: org, private, public. |
|
|
Who can vote on this board. One of disabled, members, observers, org, public. |
|
|
Who can comment on cards on this board. One of: disabled, members, observers, org, public. |
|
|
Determines what types of members can invite users to join. One of: admins, members. |
|
|
Determines whether users can join the boards themselves or whether they have to be invited. |
|
|
Determines whether card covers are enabled. |
|
|
The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey. |
|
|
Determines the type of card aging that should take place on the board if card aging is enabled. One of: pirate, regular. |
|
|
N/A |
POST Create a Checklist
/checklists
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card that the checklist should be added to. |
|
|
The name of the checklist. Should be a string of length 1 to 16384. |
|
|
The position of the checklist on the card. One of: top, bottom, or a positive number. |
|
|
The ID of a checklist to copy into the new checklist. |
|
|
N/A |
POST Create a Label
/labels
Create a new Label on a Board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Name for the label |
|
|
The color for the label. |
|
|
The ID of the Board to create the Label on. |
|
|
N/A |
POST Create a Label on a Board
/boards/{id}/labels
Create a new Label on a Board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
The name of the label to be created. 1 to 16384 characters long. |
|
|
Sets the color of the new label. Valid values are a label color or null. |
|
|
N/A |
POST Create a List on a Board
/boards/{id}/lists
Create a new List on a Board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
The name of the list to be created. 1 to 16384 characters long. |
|
|
Determines the position of the list. Valid values: top, bottom, or a positive number. |
|
|
N/A |
POST Create a Listing for Plugin
/plugins/{idPlugin}/listing
Create a new listing for a given locale for your Power-Up
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Power-Up for which you are creating a new listing. |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The description to show for the given locale |
|
|
The locale that this listing should be displayed for. |
|
|
The overview to show for the given locale. |
|
|
The name to use for the given locale. |
POST Create a Tag for a Board
/boards/{id}/idTags
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
The id of a tag from the organization to which this board belongs. |
|
|
N/A |
POST Create a Tag in Organization
/organizations/{id}/tags
Create a Tag in an Organization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the Organization |
|
|
N/A |
POST Create a Webhook
/webhooks/
Create a new webhook.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A string with a length from 0 to 16384. |
|
|
A valid URL that is reachable with a HEAD and POST request. |
|
|
ID of the model to be monitored |
|
|
Determines whether the webhook is active and sending POST requests. |
|
|
N/A |
POST Create a calendarKey for a Board
/boards/{id}/calendarKey/generate
Create a new board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
N/A |
POST Create a emailKey for a Board
/boards/{id}/emailKey/generate
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
N/A |
POST Create a new Card
/cards
Create a new card. Query parameters may also be replaced with a JSON request body instead.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name for the card |
|
|
The description for the card |
|
|
The position of the new card. top, bottom, or a positive float |
|
|
A due date for the card |
|
|
The start date of a card, or null |
|
|
N/A |
|
|
The ID of the list the card should be created in |
|
|
Comma-separated list of member IDs to add to the card |
|
|
Comma-separated list of label IDs to add to the card |
|
|
A URL starting with http:// or https:// |
|
|
N/A |
|
|
The mimeType of the attachment. Max length 256 |
|
|
The ID of a card to copy into the new card |
|
|
If using idCardSource you can specify which properties to copy over. all or comma-separated list of: attachments,checklists,customFields,comments,due,start,labels,members,start,stickers |
|
|
For use with/by the Map View |
|
|
For use with/by the Map View |
|
|
For use with/by the Map View. Should take the form latitude,longitude |
|
|
N/A |
POST Create a new Custom Field on a Board
/customFields
Create a new Custom Field on a board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
The type of model that the Custom Field is being defined on. This should always be board. |
|
|
The name of the Custom Field |
|
|
The type of Custom Field to create. |
|
|
If the type is checkbox |
|
|
Whether this Custom Field should be shown on the front of Cards |
POST Create a new Label on a Card
/cards/{id}/labels
Create a new label for the board and add it to the given card.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
A valid label color or null. See labels |
|
|
A name for the label |
|
|
N/A |
POST Create a new List
/lists
Create a new List on a Board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Name for the list |
|
|
The long ID of the board the list should be created on |
|
|
ID of the List to copy into the new List |
|
|
Position of the list. top, bottom, or a positive floating point number |
|
|
N/A |
POST Create a new Organization
/organizations
Create a new Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name to display for the Organization |
|
|
The description for the organizations |
|
|
A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. If the name contains invalid characters, they will be removed. If the name conflicts with an existing name, a new name will be substituted. |
|
|
A URL starting with http:// or https:// |
|
|
N/A |
POST Create a new custom Board Background
/members/{id}/customBoardBackgrounds
Upload a new custom board background
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
|
|
N/A |
POST Create an auth Token for an Enterprise.
/enterprises/{id}/tokens
Create an auth Token for an Enterprise.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
One of: 1hour, 1day, 30days, never |
|
|
N/A |
POST Create custom Emoji for Member
/members/{id}/customEmoji
Create a new custom Emoji
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
|
|
Name for the emoji. 2 - 64 characters |
|
|
N/A |
POST Create custom Sticker for Member
/members/{id}/customStickers
Upload a new custom sticker
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
|
|
N/A |
POST Create saved Search for Member
/members/{id}/savedSearches
Create a saved search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The name for the saved search |
|
|
The search query |
|
|
The position of the saved search. top, bottom, or a positive float. |
|
|
N/A |
PUT Deactivate a Member of an Enterprise.
/enterprises/{id}/members/{idMember}/deactivated
Deactivate a Member of an Enterprise.
NOTE: Deactivation is not possible for enterprises that have opted in to user management via AdminHub.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
ID of the Member to deactive. |
|
|
Determines whether the user is deactivated or not. |
|
|
A comma separated list of any valid values that the [nested member field resource]() accepts. |
|
|
Any valid value that the nested organization resource accepts. |
|
|
Any valid value that the nested board resource accepts. |
|
|
N/A |
PUT Deactivate or reactivate a member of an Organization
/organizations/{id}/members/{idMember}/deactivated
Deactivate or reactivate a member of a Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
The ID or username of the member to update |
|
|
N/A |
|
|
N/A |
PUT Decline enterpriseJoinRequests from one organization or a bulk list of organizations.
/enterprises/${id}/enterpriseJoinRequest/bulk
Decline enterpriseJoinRequests from one organization or bulk amount of organizations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Enterprise to retrieve. |
|
|
An array of IDs of an Organization resource. |
|
|
N/A |
DELETE Delete Action's Reaction
/actions/{idAction}/reactions/{id}
Deletes a reaction
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Action |
|
|
The ID of the reaction |
|
|
N/A |
DELETE Delete Checkitem from Checklist
/checklists/{id}/checkItems/{idCheckItem}
Remove an item from a checklist
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
ID of the check item to retrieve. |
|
|
N/A |
DELETE Delete Logo for Organization
/organizations/{id}/logo
Delete a the logo from a Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
N/A |
DELETE Delete Option of Custom Field dropdown
/customFields/{id}/options/{idCustomFieldOption}
Delete an option from a Custom Field dropdown.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the customfielditem. |
|
|
ID of the customfieldoption to retrieve. |
|
|
N/A |
DELETE Delete Star for Board
/members/{id}/boardStars/{idStar}
Unstar a board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the board star |
|
|
N/A |
DELETE Delete a Board
/boards/{id}
Delete a board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to delete |
|
|
N/A |
DELETE Delete a Card
/cards/{id}
Delete a Card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
N/A |
DELETE Delete a Checklist
/checklists/{id}
Delete a checklist
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
N/A |
DELETE Delete a Checklist on a Card
/cards/{id}/checklists/{idChecklist}
Delete a checklist from a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the checklist to delete |
|
|
N/A |
DELETE Delete a Custom Field definition
/customFields/{id}
Delete a Custom Field from a board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Custom Field. |
|
|
N/A |
DELETE Delete a Label
/labels/{id}
Delete a label by ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Label |
|
|
N/A |
DELETE Delete a Member's custom Board background
/members/{id}/boardBackgrounds/{idBackground}
Delete a board background
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the board background |
|
|
N/A |
DELETE Delete a Member's custom Sticker
/members/{id}/customStickers/{idSticker}
Delete a Member's custom Sticker
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the uploaded sticker |
|
|
N/A |
DELETE Delete a Sticker on a Card
/cards/{id}/stickers/{idSticker}
Remove a sticker from the card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the sticker |
|
|
N/A |
DELETE Delete a Token
/tokens/{token}/
Delete a token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete a Webhook
/webhooks/{id}
Delete a webhook by ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the webhook to retrieve. |
|
|
N/A |
DELETE Delete a Webhook created by Token
/tokens/{token}/webhooks/{idWebhook}
Delete a webhook created with given token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Webhooks to retrieve. |
|
|
N/A |
DELETE Delete a comment on a Card
/cards/{id}/actions/{idAction}/comments
Delete a comment
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the comment action to update |
|
|
N/A |
DELETE Delete a saved search
/members/{id}/savedSearches/{idSearch}
Delete a saved search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the saved search to delete |
|
|
N/A |
DELETE Delete an Action
/actions/{id}
Delete a specific action. Only comment actions can be deleted.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Action |
|
|
N/A |
DELETE Delete an Attachment on a Card
/cards/{id}/attachments/{idAttachment}
Delete an Attachment
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the attachment to delete |
|
|
N/A |
DELETE Delete an Organization
/organizations/{id}
Delete an Organization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the Organization |
|
|
N/A |
DELETE Delete an Organization from an Enterprise.
/enterprises/{id}/organizations/{idOrg}
Remove an organization from an enterprise.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
ID of the organization to be removed from the enterprise. |
|
|
N/A |
DELETE Delete an Organization's Tag
/organizations/{id}/tags/{idTag}
Delete an organization's tag
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
The ID of the tag to delete |
|
|
N/A |
DELETE Delete checkItem on a Card
/cards/{id}/checkItem/{idCheckItem}
Delete a checklist item
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the checkitem |
|
|
N/A |
DELETE Delete custom Board Background of Member
/members/{id}/customBoardBackgrounds/{idBackground}
Delete a specific custom board background
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the custom background |
|
|
N/A |
DELETE Delete the email domain restriction on who can be invited to the Workspace
/organizations/{id}/prefs/orgInviteRestrict
Remove the email domain restriction on who can be invited to the Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
N/A |
DELETE Disable a Power-Up on a Board
/boards/{id}/boardPlugins/{idPlugin}
Disable a Power-Up on a board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
The ID of the Power-Up to disable |
|
|
N/A |
POST Dismiss a message for Member
/members/{id}/oneTimeMessagesDismissed
Dismiss a message
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The message to dismiss |
|
|
N/A |
POST Enable a Power-Up on a Board
/boards/{id}/boardPlugins
Enable a Power-Up on a Board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Board |
|
|
The ID of the Power-Up to enable |
|
|
N/A |
GET Get Action's Reaction
/actions/{idAction}/reactions/{id}
Get information for a reaction
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Action |
|
|
The ID of the reaction |
|
|
Whether to load the member as a nested resource. See Members Nested Resource |
|
|
Whether to load the emoji as a nested resource. |
|
|
N/A |
GET Get Action's Reactions
/actions/{idAction}/reactions
List reactions for an action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the action |
|
|
Whether to load the member as a nested resource. See Members Nested Resource |
|
|
Whether to load the emoji as a nested resource. |
|
|
N/A |
GET Get Actions for Organization
/organizations/{id}/actions
List the actions on a Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
N/A |
GET Get Actions for a List
/lists/{id}/actions
Get the Actions on a List
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the list |
|
|
A comma-separated list of action types. |
|
|
N/A |
GET Get Actions of a Board
/boards/{boardId}/actions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The fields to be returned for the Actions. See Action fields here. |
|
|
A comma-separated list of action types. |
|
|
The format of the returned Actions. Either list or count. |
|
|
A comma-separated list of idModels. Only actions related to these models will be returned. |
|
|
The limit of the number of responses, between 0 and 1000. |
|
|
Whether to return the member object for each action. |
|
|
The fields of the member to return. |
|
|
Whether to return the memberCreator object for each action. |
|
|
The fields of the member creator to return |
|
|
The page of results for actions. |
|
|
Whether to show reactions on comments or not. |
|
|
An Action ID |
|
|
An Action ID |
|
|
N/A |
GET Get Actions on a Card
/cards/{id}/actions
List the Actions on a Card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
A comma-separated list of action types. |
|
|
The page of results for actions. Each page of results has 50 actions. |
|
|
N/A |
GET Get Application's compliance data
/applications/{key}/compliance
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Attachments on a Card
/cards/{id}/attachments
List the attachments on a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
all or a comma-separated list of attachment fields |
|
|
Use cover to restrict to just the cover attachment |
|
|
N/A |
GET Get Boards in an Organization
/organizations/{id}/boards
List the boards in a Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
all or a comma-separated list of: open, closed, members, organization, public |
|
|
all or a comma-separated list of board fields |
|
|
N/A |
GET Get Boards that Member belongs to
/members/{id}/boards
Lists the boards that the user is a member of.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
all or a comma-separated list of: closed, members, open, organization, public, starred |
|
|
all or a comma-separated list of board fields |
|
|
Which lists to include with the boards. One of: all, closed, none, open |
|
|
Whether to include the Organization object with the Boards |
|
|
all or a comma-separated list of organization fields |
|
|
N/A |
GET Get Boards the Member has been invited to
/members/{id}/boardsInvited
Get the boards the member has been invited to
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
all or a comma-separated list of board fields |
|
|
N/A |
GET Get Cards in a List
/lists/{id}/cards
List the cards in a list
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the list |
|
|
N/A |
GET Get Cards on a Board
/boards/{id}/cards
Get all of the open Cards on a Board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Cards the Member is on
/members/{id}/cards
Gets the cards a member is on
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
One of: all, closed, none, open, visible |
|
|
N/A |
GET Get Checkitems on a Checklist
/checklists/{id}/checkItems
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
One of: all, none. |
|
|
One of: all, name, nameData, pos, state,type, due, dueReminder, idMember. |
|
|
N/A |
GET Get Checklists on a Board
/boards/{id}/checklists
Get all of the checklists on a Board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
N/A |
GET Get Checklists on a Card
/cards/{id}/checklists
Get the checklists on a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
all or none |
|
|
all or a comma-separated list of: name,nameData,pos,state,type,due,dueReminder,idMember |
|
|
all or none |
|
|
all or a comma-separated list of: idBoard,idCard,name,pos |
|
|
N/A |
GET Get ClaimableOrganizations of an Enterprise
/enterprises/{id}/claimableOrganizations
Get the Workspaces that are claimable by the enterprise by ID. Can optionally query for workspaces based on activeness/ inactiveness.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve |
|
|
Limits the number of workspaces to be sorted |
|
|
Specifies the sort order to return matching documents |
|
|
Name of the enterprise to retrieve workspaces for |
|
|
Date in YYYY-MM-DD format indicating the date to search up to for activeness of workspace |
|
|
Date in YYYY-MM-DD format indicating the date to search up to for inactiveness of workspace |
|
|
N/A |
GET Get Custom Field Items for a Card
/cards/{id}/customFieldItems
Get the custom field items for a card.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
N/A |
GET Get Custom Fields for Board
/boards/{id}/customFields
Get the Custom Field Definitions that exist on a board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
N/A |
GET Get Enabled Power-Ups on Board
/boards/{id}/boardPlugins
Get the enabled Power-Ups on a board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Board |
|
|
N/A |
GET Get Enterprise admin Members
/enterprises/{id}/admins
Get an enterprise's admin members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
Any valid value that the [nested member field resource]() accepts. |
|
|
N/A |
GET Get Labels on a Board
/boards/{id}/labels
Get all of the Labels on a Board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Board. |
|
|
The fields to be returned for the Labels. |
|
|
The number of Labels to be returned. |
|
|
N/A |
GET Get Lists on a Board
/boards/{id}/lists
Get the Lists on a Board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
Filter to apply to Cards. |
|
|
all or a comma-separated list of card fields |
|
|
Filter to apply to Lists |
|
|
all or a comma-separated list of list fields |
|
|
N/A |
GET Get Member's Boards New
/1/members/me/boards
Get Member's Boards New
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
One of: all, custom, default, none, premium |
|
|
N/A |
GET Get Member's Notifications
/members/{id}/notifications
Get a member's notifications
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
One of: all, read, unread |
|
|
all or a comma-separated list of notification fields |
|
|
Max 1000 |
|
|
Max 100 |
|
|
A notification ID |
|
|
A notification ID |
|
|
N/A |
|
|
all or a comma-separated list of member fields |
|
|
N/A |
GET Get Member's Organizations
/members/{id}/organizations
Get a member's Workspaces
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
One of: all, members, none, public (Note: members filters to only private Workspaces) |
|
|
all or a comma-separated list of organization fields |
|
|
Whether or not to include paid account information in the returned workspace object |
|
|
N/A |
GET Get Member's Tokens
/members/{id}/tokens
List a members app tokens
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
Whether to include webhooks |
|
|
N/A |
GET Get Member's custom Board backgrounds
/members/{id}/boardBackgrounds
Get a member's custom board backgrounds
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
One of: all, custom, default, none, premium |
|
|
N/A |
GET Get Member's custom Stickers
/members/{id}/customStickers
Get a Member's uploaded stickers
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
GET Get Member's saved searched
/members/{id}/savedSearches
List the saved searches of a Member
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
GET Get Members of Enterprise
/enterprises/{id}/members
Get the members of an enterprise.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Enterprise to retrieve. |
|
|
A comma-seperated list of valid member fields. |
|
|
Pass a SCIM-style query to filter members. This takes precedence over the all/normal/admins value of members. If any of the below member_* args are set, the member array will be paginated. |
|
|
This parameter expects a SCIM-style sorting value prefixed by a - to sort descending. If no - is prefixed, it will be sorted ascending. Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data. |
|
|
Deprecated: Please use sort instead. This parameter expects a SCIM-style sorting value. Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data. |
|
|
Deprecated: Please use sort instead. One of: ascending, descending, asc, desc. |
|
|
Any integer between 0 and 9999. |
|
|
SCIM-style filter. |
|
|
Any valid value that the nested organization field resource accepts. |
|
|
Any valid value that the nested board resource accepts. |
|
|
N/A |
GET Get Members who have voted on a Card
/cards/{id}/membersVoted
Get the members who have voted on a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
all or a comma-separated list of member fields |
|
|
N/A |
GET Get Memberships of a Board
/boards/{id}/memberships
Get information about the memberships users have to the board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
One of admins, all, none, normal |
|
|
Works for premium organizations only. |
|
|
Shows the type of member to the org the user is. For instance, an org admin will have a orgMemberType of admin. |
|
|
Determines whether to include a nested member object. |
|
|
Fields to show if member=true. Valid values: nested member resource fields. |
|
|
N/A |
GET Get Memberships of an Organization
/organizations/{id}/memberships
List the memberships of a Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
all or a comma-separated list of: active, admin, deactivated, me, normal |
|
|
Whether to include the Member objects with the Memberships |
|
|
N/A |
GET Get Option of Custom Field dropdown
/customFields/{id}/options/{idCustomFieldOption}
Retrieve a specific, existing Option on a given dropdown-type Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the customfielditem. |
|
|
ID of the customfieldoption to retrieve. |
|
|
N/A |
GET Get Options of Custom Field drop down
/customFields/{id}/options
Get the options of a drop down Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the customfield. |
|
|
N/A |
GET Get Organizations a Member has been invited to
/members/{id}/organizationsInvited
Get a member's Workspaces they have been invited to
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
all or a comma-separated list of organization fields |
|
|
N/A |
GET Get Organizations new billable guests
/organizations/{id}/newBillableGuests/{idBoard}
Used to check whether the given board has new billable guests on it.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
The ID of the board to check for new billable guests. |
|
|
N/A |
GET Get PendingOrganizations of an Enterprise
/enterprises/{id}/pendingOrganizations
Get the Workspaces that are pending for the enterprise by ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve |
|
|
Date in YYYY-MM-DD format indicating the date to search up to for activeness of workspace |
|
|
Date in YYYY-MM-DD format indicating the date to search up to for inactiveness of workspace |
|
|
N/A |
GET Get Plugin's Member privacy compliance
/plugins/{id}/compliance/memberPrivacy
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Power-Up |
|
|
N/A |
GET Get Power-Ups on a Board
/boards/{id}/plugins
List the Power-Ups on a board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
One of: enabled or available |
|
|
N/A |
GET Get Stickers on a Card
/cards/{id}/stickers
Get the stickers on a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
all or a comma-separated list of sticker fields |
|
|
N/A |
GET Get Tags of an Organization
/organizations/{id}/tags
List the organization's collections
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the Organization |
|
|
N/A |
GET Get Token's Member
/tokens/{token}/member
Retrieve information about a token's owner by token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
all or a comma-separated list of valid fields for Member Object. |
|
|
N/A |
GET Get Users of an Enterprise
/enterprises/{id}/members/query
Get an enterprise's users. You can choose to retrieve licensed members, board guests, etc.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
When true, returns members who possess a license for the corresponding Trello Enterprise; when false, returns members who do not. If unspecified, both licensed and unlicensed members will be returned. |
|
|
When true, returns members who have been deactivated for the corresponding Trello Enterprise; when false, returns members who have not. If unspecified, both active and deactivated members will be returned. |
|
|
When true, returns members who are guests on one or more boards in the corresponding Trello Enterprise (but do not possess a license); when false, returns members who are not. If unspecified, both guests and non-guests will be returned. |
|
|
When true, returns members who are managed by the corresponding Trello Enterprise; when false, returns members who are not. If unspecified, both managed and unmanaged members will be returned. |
|
|
When true, returns members who are administrators of the corresponding Trello Enterprise; when false, returns members who are not. If unspecified, both admin and non-admin members will be returned. |
|
|
Returns only Trello users active since this date (inclusive). |
|
|
Returns only Trello users active since this date (inclusive). |
|
|
Returns members with email address or full name that start with the search value. |
|
|
Cursor to return next set of results |
|
|
N/A |
GET Get Webhooks for Token
/tokens/{token}/webhooks
Retrieve all webhooks created with a Token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get a Board
/boards/{id}
Request a single board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
This is a nested resource. Read more about actions as nested resources here. |
|
|
Valid values are one of: mine or none. |
|
|
This is a nested resource. Read more about cards as nested resources here. |
|
|
Use with the cards param to include card pluginData with the response |
|
|
This is a nested resource. Read more about checklists as nested resources here. |
|
|
This is a nested resource. Read more about custom fields as nested resources here. |
|
|
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 |
|
|
This is a nested resource. Read more about labels as nested resources here. |
|
|
This is a nested resource. Read more about lists as nested resources here. |
|
|
This is a nested resource. Read more about members as nested resources here. |
|
|
This is a nested resource. Read more about memberships as nested resources here. |
|
|
Determines whether the pluginData for this board should be returned. Valid values: true or false. |
|
|
This is a nested resource. Read more about organizations as nested resources here. |
|
|
Use with the organization param to include organization pluginData with the response |
|
|
N/A |
|
|
Also known as collections, tags, refer to the collection(s) that a Board belongs to. |
|
|
N/A |
GET Get a Card
/cards/{id}
Get a card by its ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
all or a comma-separated list of fields. Defaults: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, start, email, idBoard, idChecklists, idLabels, idList, idMembers, idShort, idAttachmentCover, manualCoverAttachment, labels, name, pos, shortUrl, url |
|
|
See the Actions Nested Resource |
|
|
true, false, or cover |
|
|
all or a comma-separated list of attachment fields |
|
|
Whether to return member objects for members on the card |
|
|
all or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username |
|
|
Whether to return member objects for members who voted on the card |
|
|
all or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username |
|
|
N/A |
|
|
Whether to return the checklists on the card. all or none |
|
|
all or a comma-separated list of idBoard,idCard,name,pos |
|
|
Whether to return the board object the card is on |
|
|
all or a comma-separated list of board fields. Defaults: name, desc, descData, closed, idOrganization, pinned, url, prefs |
|
|
See the Lists Nested Resource |
|
|
Whether to include pluginData on the card with the response |
|
|
Whether to include sticker models with the response |
|
|
all or a comma-separated list of sticker fields |
|
|
Whether to include the customFieldItems |
|
|
N/A |
GET Get a Card on a Board
/boards/{id}/cards/{idCard}
Get a single Card on a Board.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
The id the card to retrieve. |
|
|
The fields to be returned for the Actions. See Action fields here. |
|
|
A comma-separated list of action types. |
|
|
The format of the returned Actions. Either list or count. |
|
|
A comma-separated list of idModels. Only actions related to these models will be returned. |
|
|
The limit of the number of responses, between 0 and 1000. |
|
|
Whether to return the member object for each action. |
|
|
The fields of the member to return. |
|
|
Whether to return the memberCreator object for each action. |
|
|
The fields of the member creator to return |
|
|
The page of results for actions. |
|
|
Whether to show reactions on comments or not. |
|
|
An Action ID |
|
|
An Action ID |
|
|
N/A |
GET Get a Checkitem on a Checklist
/checklists/{id}/checkItems/{idCheckItem}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
ID of the check item to retrieve. |
|
|
One of: all, name, nameData, pos, state, type, due, dueReminder, idMember,. |
|
|
N/A |
GET Get a Checklist
/checklists/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
Valid values: all, closed, none, open, visible. Cards is a nested resource. The additional query params available are documented at Cards Nested Resource. |
|
|
The check items on the list to return. One of: all, none. |
|
|
The fields on the checkItem to return if checkItems are being returned. all or a comma-separated list of: name, nameData, pos, state, type, due, dueReminder, idMember |
|
|
all or a comma-separated list of checklist fields |
|
|
N/A |
GET Get a Custom Field
/customFields/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Custom Field. |
|
|
N/A |
GET Get a Label
/labels/{id}
Get information about a single Label.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Label |
|
|
all or a comma-separated list of fields |
|
|
N/A |
GET Get a List
/lists/{id}
Get information about a List
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the list |
|
|
all or a comma separated list of List field names. |
|
|
N/A |
GET Get a Member
/members/{id}
Get a member
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
See the Actions Nested Resource |
|
|
See the Boards Nested Resource |
|
|
One of: all, custom, default, none, premium |
|
|
all or a comma-separated list of: closed, members, open, organization, pinned, public, starred, unpinned |
|
|
all or a comma-separated list of board fields |
|
|
Whether to return the boardStars or not |
|
|
See the Cards Nested Resource for additional options |
|
|
all or none |
|
|
all or none |
|
|
all or none |
|
|
all or a comma-separated list of member fields |
|
|
See the Notifications Nested Resource |
|
|
One of: all, members, none, public |
|
|
all or a comma-separated list of organization fields |
|
|
Whether or not to include paid account information in the returned workspace object |
|
|
One of: all, members, none, public |
|
|
all or a comma-separated list of organization fields |
|
|
Whether or not to include paid account information in the returned member object |
|
|
N/A |
|
|
all or none |
|
|
N/A |
GET Get a Member of Enterprise
/enterprises/{id}/members/{idMember}
Get a specific member of an enterprise by ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
An ID of a member resource. |
|
|
A comma separated list of any valid values that the [nested member field resource]() accepts. |
|
|
Any valid value that the nested organization field resource accepts. |
|
|
Any valid value that the nested board resource accepts. |
|
|
N/A |
GET Get a Member's Actions
/members/{id}/actions
List the actions for a member
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
A comma-separated list of action types. |
|
|
N/A |
GET Get a Member's boardStars
/members/{id}/boardStars
List a member's board stars
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
GET Get a Member's custom Board Backgrounds
/members/{id}/customBoardBackgrounds
Get a member's custom board backgrounds
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
GET Get a Member's custom Emoji
/members/{id}/customEmoji/{idEmoji}
Get a Member's custom Emoji
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the custom emoji |
|
|
all or a comma-separated list of name, url |
|
|
N/A |
GET Get a Member's custom Sticker
/members/{id}/customStickers/{idSticker}
Get a Member's custom Sticker
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the uploaded sticker |
|
|
all or a comma-separated list of scaled, url |
|
|
N/A |
GET Get a Member's customEmojis
/members/{id}/customEmoji
Get a Member's uploaded custom Emojis
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
GET Get a Member's notification channel settings
/members/{id}/notificationsChannelSettings
Get a member's notification channel settings
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
GET Get a Membership of an Organization
/organizations/{id}/memberships/{idMembership}
Get a single Membership for an Organization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
The ID of the membership to load |
|
|
Whether to include the Member object in the response |
|
|
N/A |
GET Get a Notification
/notifications/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the notification |
|
|
Whether to include the board object |
|
|
all or a comma-separated list of board fields |
|
|
Whether to include the card object |
|
|
all or a comma-separated list of card fields |
|
|
Whether to include the display object with the results |
|
|
Whether to include the entities object with the results |
|
|
all or a comma-separated list of notification fields |
|
|
Whether to include the list object |
|
|
Whether to include the member object |
|
|
all or a comma-separated list of member fields |
|
|
Whether to include the member object of the creator |
|
|
all or a comma-separated list of member fields |
|
|
Whether to include the organization object |
|
|
all or a comma-separated list of organization fields |
|
|
N/A |
GET Get a Notification's associated Organization
/notifications/{id}/organization
Get the organization a notification is associated with
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the notification |
|
|
all or a comma-separated list of organization fields |
|
|
N/A |
GET Get a Plugin
/plugins/{id}/
Get plugins
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
N/A |
GET Get a Sticker on a Card
/cards/{id}/stickers/{idSticker}
Get a specific sticker on a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the sticker |
|
|
all or a comma-separated list of sticker fields |
|
|
N/A |
GET Get a Token
/tokens/{token}
Retrieve information about a token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
all or a comma-separated list of dateCreated, dateExpires, idMember, identifier, permissions |
|
|
Determines whether to include webhooks. |
|
|
N/A |
GET Get a Webhook
/webhooks/{id}
Get a webhook by ID. You must use the token query parameter and pass in the token the webhook was created under, or else you will encounter a 'webhook does not belong to token' error.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the webhook to retrieve. |
|
|
N/A |
GET Get a Webhook belonging to a Token
/tokens/{token}/webhooks/{idWebhook}
Retrieve a webhook created with a Token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Webhooks to retrieve. |
|
|
N/A |
GET Get a boardBackground of a Member
/members/{id}/boardBackgrounds/{idBackground}
Get a member's board background
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the board background |
|
|
all or a comma-separated list of: brightness, fullSizeUrl, scaled, tile |
|
|
N/A |
GET Get a boardStar of Member
/members/{id}/boardStars/{idStar}
Get a specific boardStar
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the board star |
|
|
N/A |
GET Get a bulk list of organizations that can be transferred to an enterprise.
/enterprises/{id}/transferrable/bulk/{idOrganizations}
Get a list of organizations that can be transferred to an enterprise when given a bulk list of organizations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Enterprise to retrieve. |
|
|
An array of IDs of an Organization resource. |
|
|
N/A |
GET Get a field of a Notification
/notifications/{id}/{field}
Get a specific property of a notification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the notification |
|
|
A notification field |
|
|
N/A |
GET Get a field on a Board
/boards/{id}/{field}
Get a single, specific field on a board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board. |
|
|
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. |
|
|
N/A |
GET Get a field on a Card
/cards/{id}/{field}
Get a specific property of a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The desired field. |
|
|
N/A |
GET Get a field on a Member
/members/{id}/{field}
Get a particular property of a member
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
One of the member fields |
|
|
N/A |
GET Get a field on a Webhook
/webhooks/{id}/{field}
Get a field on a Webhook
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the webhook. |
|
|
Field to retrieve. One of: active, callbackURL, description, idModel |
|
|
N/A |
GET Get a saved search
/members/{id}/savedSearches/{idSearch}
Get a saved search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the saved search to delete |
|
|
N/A |
GET Get a specific field on an Action
/actions/{id}/{field}
Get a specific property of an action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Action |
|
|
An action field |
|
|
N/A |
GET Get an Action
/actions/{id}
Get an Action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Action |
|
|
N/A |
|
|
N/A |
|
|
all or a comma-separated list of action fields |
|
|
N/A |
|
|
all or a comma-separated list of member fields |
|
|
Whether to include the member object for the creator of the action |
|
|
all or a comma-separated list of member fields |
|
|
N/A |
GET Get an Attachment on a Card
/cards/{id}/attachments/{idAttachment}
Get a specific Attachment on a Card.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the Attachment |
|
|
The Attachment fields to be included in the response. |
|
|
N/A |
GET Get an Enterprise
/enterprises/{id}
Get an enterprise by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
Comma-separated list of: id, name, displayName, prefs, ssoActivationFailed, idAdmins, idMembers (Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data. Read the SCIM documentation [here]() for more information on filtering), idOrganizations, products, userTypes, idMembers, idOrganizations |
|
|
One of: none, normal, admins, owners, all |
|
|
One of: avatarHash, fullName, initials, username |
|
|
Pass a SCIM-style query to filter members. This takes precedence over the all/normal/admins value of members. If any of the member_* args are set, the member array will be paginated. |
|
|
This parameter expects a SCIM-style sorting value prefixed by a - to sort descending. If no - is prefixed, it will be sorted ascending. Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data. |
|
|
Deprecated: Please use member_sort. This parameter expects a SCIM-style sorting value. Note that the members array returned will be paginated if members is normal or admins. Pagination can be controlled with member_startIndex, etc, and the API response's header will contain the total count and pagination state. |
|
|
Deprecated: Please use member_sort. One of: ascending, descending, asc, desc |
|
|
Any integer between 0 and 100. |
|
|
0 to 100 |
|
|
One of: none, members, public, all |
|
|
Any valid value that the [nested organization field resource]() accepts. |
|
|
Whether or not to include paid account information in the returned workspace objects |
|
|
Comma-seperated list of: me, normal, admin, active, deactivated |
|
|
N/A |
GET Get an Organization
/organizations/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the Organization |
|
|
N/A |
GET Get auditlog data for an Enterprise
/enterprises/{id}/auditlog
Returns an array of Actions related to the Enterprise object. Used for populating data sent to Google Sheets from an Enterprise's audit log page: https://trello.com/e/{enterprise_name}/admin/auditlog. An Enterprise admin token is required for this route.
NOTE: For enterprises that have opted in to user management via AdminHub, the auditlog will will contain actions taken in AdminHub, but may not contain the source for those actions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
N/A |
GET Get blocked notification keys of Member on this channel
/members/{id}/notificationsChannelSettings/{channel}
Get blocked notification keys of Member on a specific channel
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
Channel to block notifications on |
|
|
N/A |
GET Get boardStars on a Board
/boards/{boardId}/boardStars
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Valid values: mine, none |
|
|
N/A |
GET Get checkItem on a Card
/cards/{id}/checkItem/{idCheckItem}
Get a specific checkItem on a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the checkitem |
|
|
all or a comma-separated list of name,nameData,pos,state,type,due,dueReminder,idMember |
|
|
N/A |
GET Get checkItems on a Card
/cards/{id}/checkItemStates
Get the completed checklist items on a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
all or a comma-separated list of: idCheckItem, state |
|
|
N/A |
GET Get custom Board Background of Member
/members/{id}/customBoardBackgrounds/{idBackground}
Get a specific custom board background
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the custom background |
|
|
N/A |
GET Get field on Organization
/organizations/{id}/{field}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
An organization field |
|
|
N/A |
GET Get field on a Checklist
/checklists/{id}/{field}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
Field to update. |
|
|
N/A |
GET Get filtered Cards on a Board
/boards/{id}/cards/{filter}
Get the Cards on a Board that match a given filter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Board |
|
|
Valid Values: all, closed, none, open, visible. |
|
|
N/A |
GET Get filtered Lists on a Board
/boards/{id}/lists/{filter}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
One of all, closed, none, open |
|
|
N/A |
GET Get pluginData on a Card
/cards/{id}/pluginData
Get any shared pluginData on a card.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
N/A |
GET Get signupUrl for Enterprise
/enterprises/{id}/signupUrl
Get the signup URL for an enterprise.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
N/A |
|
|
N/A |
|
|
Any valid URL. |
|
|
Designates whether the user has seen/consented to the Trello ToS prior to being redirected to the enterprise signup page/their IdP. |
|
|
N/A |
GET Get the Board a List is on
/lists/{id}/board
Get the board a list is on
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the list |
|
|
all or a comma-separated list of board fields |
|
|
N/A |
GET Get the Board a Notification is on
/notifications/{id}/board
Get the board a notification is associated with
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the notification |
|
|
all or a comma-separated list of boardfields |
|
|
N/A |
GET Get the Board for an Action
/actions/{id}/board
Get the Board for an Action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the action |
|
|
all or a comma-separated list of board fields |
|
|
N/A |
GET Get the Board the Card is on
/cards/{id}/board
Get the board a card is on
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
all or a comma-separated list of board fields |
|
|
N/A |
GET Get the Board the Checklist is on
/checklists/{id}/board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
all or a comma-separated list of board fields |
|
|
N/A |
GET Get the Card a Checklist is on
/checklists/{id}/cards
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
N/A |
GET Get the Card a Notification is on
/notifications/{id}/card
Get the card a notification is associated with
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the notification |
|
|
all or a comma-separated list of card fields |
|
|
N/A |
GET Get the Card for an Action
/actions/{id}/card
Get the card for an action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the action |
|
|
all or a comma-separated list of card fields |
|
|
N/A |
GET Get the List a Notification is on
/notifications/{id}/list
Get the list a notification is associated with
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the notification |
|
|
all or a comma-separated list of list fields |
|
|
N/A |
GET Get the List for an Action
/actions/{id}/list
Get the List for an Action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the action |
|
|
all or a comma-separated list of list fields |
|
|
N/A |
GET Get the List of a Card
/cards/{id}/list
Get the list a card is in
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
all or a comma-separated list of list fields |
|
|
N/A |
GET Get the Member Creator of an Action
/actions/{id}/memberCreator
Get the Member who created the Action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Action |
|
|
all or a comma-separated list of member fields |
|
|
N/A |
GET Get the Member a Notification is about (not the creator)
/notifications/{id}/member
Get the member (not the creator) a notification is about
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the notification |
|
|
all or a comma-separated list of member fields |
|
|
N/A |
GET Get the Member of an Action
/actions/{id}/member
Gets the member of an action (not the creator)
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Action |
|
|
all or a comma-separated list of member fields |
|
|
N/A |
GET Get the Member who created the Notification
/notifications/{id}/memberCreator
Get the member who created the notification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the notification |
|
|
all or a comma-separated list of member fields |
|
|
N/A |
GET Get the Members of a Board
/boards/{id}/members
Get the Members for a board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
N/A |
GET Get the Members of a Card
/cards/{id}/members
Get the members on a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
all or a comma-separated list of member fields |
|
|
N/A |
GET Get the Members of an Organization
/organizations/{id}/members
List the members in a Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the Organization |
|
|
N/A |
GET Get the Organization of an Action
/actions/{id}/organization
Get the Organization of an Action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the action |
|
|
all or a comma-separated list of organization fields |
|
|
N/A |
GET Get the pluginData Scoped to Organization
/organizations/{id}/pluginData
Get organization scoped pluginData on this Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
N/A |
GET Get whether an organization can be transferred to an enterprise.
/enterprises/{id}/transferrable/organization/{idOrganization}
Get whether an organization can be transferred to an enterprise.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Enterprise to retrieve. |
|
|
An ID of an Organization resource. |
|
|
N/A |
PUT Invite Member to Board via email
/boards/{id}/members
Invite a Member to a Board via their email address.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the board |
|
|
The email address of a user to add as a member of the board. |
|
|
Valid values: admin, normal, observer. Determines what type of member the user being added should be of the board. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
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. |
GET List Action's summary of Reactions
/actions/{idAction}/reactionsSummary
List a summary of all reactions for an action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the action |
|
|
N/A |
GET List available Emoji
/emoji
List available Emoji
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The locale to return emoji descriptions and names in. Defaults to the logged in member's locale. |
|
|
true to return spritesheet URLs in the response |
|
|
N/A |
POST Mark Board as viewed
/boards/{id}/markedAsViewed
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
N/A |
POST Mark a Card's Notifications as read
/cards/{id}/markAssociatedNotificationsRead
Mark notifications about this card as read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
N/A |
POST Mark all Notifications as read
/notifications/all/read
Mark all notifications as read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Boolean to specify whether to mark as read or unread (defaults to true, marking as read) |
|
|
A comma-seperated list of IDs. Allows specifying an array of notification IDs to change the read state for. This will become useful as we add grouping of notifications to the UI, with a single button to mark all notifications in the group as read/unread. |
|
|
N/A |
PUT Move List to Board
/lists/{id}/idBoard
Move a List to a different Board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the list |
|
|
The ID of the board to move the list to |
|
|
N/A |
POST Move all Cards in List
/lists/{id}/moveAllCards
Move all Cards in a List
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the list |
|
|
The ID of the board the cards should be moved to |
|
|
The ID of the list that the cards should be moved to |
|
|
N/A |
DELETE Remove Member from Board
/boards/{id}/members/{idMember}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
The id of the member to add to the board. |
|
|
N/A |
DELETE Remove a Label from a Card
/cards/{id}/idLabels/{idLabel}
Remove a label from a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the label to remove |
|
|
N/A |
DELETE Remove a Member as admin from Enterprise.
/enterprises/{id}/admins/{idMember}
Remove a member as admin from an enterprise.
NOTE: This endpoint is not available to enterprises that have opted in to user management via AdminHub.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Enterprise to retrieve. |
|
|
ID of the member to be removed as an admin from enterprise. |
|
|
N/A |
DELETE Remove a Member from a Card
/cards/{id}/idMembers/{idMember}
Remove a member from a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the member to remove from the card |
|
|
N/A |
DELETE Remove a Member from an Organization
/organizations/{id}/members/{idMember}
Remove a member from a Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
The ID of the Member to remove from the Workspace |
|
|
N/A |
DELETE Remove a Member from an Organization and all Organization Boards
/organizations/{id}/members/{idMember}/all
Remove a member from a Workspace and from all Workspace boards
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
The ID of the member to remove from the Workspace |
|
|
N/A |
DELETE Remove a Member's Vote on a Card
/cards/{id}/membersVoted/{idMember}
Remove a member's vote from a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the member whose vote to remove |
|
|
N/A |
DELETE Remove the associated Google Apps domain from a Workspace
/organizations/{id}/prefs/associatedDomain
Remove the associated Google Apps domain from a Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
N/A |
GET Retrieve Organization's Exports
/organizations/{id}/exports
Retrieve the exports that exist for the given organization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the Workspace |
|
|
N/A |
GET Search Trello
/search
Find what you're looking for in Trello
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The search query with a length of 1 to 16384 characters |
|
|
mine or a comma-separated list of Board IDs |
|
|
A comma-separated list of Organization IDs |
|
|
A comma-separated list of Card IDs |
|
|
What type or types of Trello objects you want to search. all or a comma-separated list of: actions, boards, cards, members, organizations |
|
|
all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url |
|
|
The maximum number of boards returned. Maximum: 1000 |
|
|
Whether to include the parent organization with board results |
|
|
all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed, url |
|
|
The maximum number of cards to return. Maximum: 1000 |
|
|
The page of results for cards. Maximum: 100 |
|
|
Whether to include the parent board with card results |
|
|
Whether to include the parent list with card results |
|
|
Whether to include member objects with card results |
|
|
Whether to include sticker objects with card results |
|
|
Whether to include attachment objects with card results. A boolean value (true or false) or cover for only card cover attachments. |
|
|
all or a comma-separated list of billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url, website |
|
|
The maximum number of Workspaces to return. Maximum 1000 |
|
|
all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username |
|
|
The maximum number of members to return. Maximum 1000 |
|
|
By default, Trello searches for each word in your query against exactly matching words within Member content. Specifying partial to be true means that we will look for content that starts with any of the words in your query. If you are looking for a Card titled "My Development Status Report", by default you would need to search for "Development". If you have partial enabled, you will be able to search for "dev" but not "velopment". |
|
|
N/A |
GET Search for Members
/search/members/
Search for Trello members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Search query 1 to 16384 characters long |
|
|
The maximum number of results to return. Maximum of 20. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Transfer an Organization to an Enterprise.
/enterprises/{id}/organizations
Transfer an organization to an enterprise.
NOTE: For enterprises that have opted in to user management via AdminHub, this endpoint will result in the organization being added to the enterprise asynchronously. A 200 response only indicates receipt of the request, it does not indicate successful addition to the enterprise.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Enterprise to retrieve. |
|
|
ID of Organization to be transferred to Enterprise. |
|
|
N/A |
PUT Update Checkitem on Checklist on Card
/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}
Update an item in a checklist on a card.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the checklist item to update |
|
|
top, bottom, or a positive float |
|
|
The ID of the item to update. |
|
|
N/A |
PUT Update Comment Action on a Card
/cards/{id}/actions/{idAction}/comments
Update an existing comment
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the comment action to update |
|
|
The new text for the comment |
|
|
N/A |
PUT Update Custom Field item on Card
/cards/{idCard}/customField/{idCustomField}/item
Setting, updating, and removing the value for a Custom Field on a card. For more details on updating custom fields check out the Getting Started With Custom Fields
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the card that the Custom Field value should be set/updated for |
|
|
ID of the Custom Field on the card. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Member to be admin of Enterprise
/enterprises/{id}/admins/{idMember}
Make Member an admin of Enterprise.
NOTE: This endpoint is not available to enterprises that have opted in to user management via AdminHub.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the enterprise to retrieve. |
|
|
ID of member to be made an admin of enterprise. |
|
|
N/A |
PUT Update Membership of Member on a Board
/boards/{id}/memberships/{idMembership}
Update an existing board by id
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
The id of a membership that should be added to this board. |
|
|
One of: admin, normal, observer. Determines the type of member that this membership will be to this board. |
|
|
Valid values: all, avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username |
|
|
N/A |
PUT Update Multiple Custom Field items on Card
/cards/{idCard}/customFields
Setting, updating, and removing the values for multiple Custom Fields on a card. For more details on updating custom fields check out the Getting Started With Custom Fields
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Notification's read status
/notifications/{id}/unread
Update Notification's read status
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the notification |
|
|
N/A |
|
|
N/A |
PUT Update a Board
/boards/{id}
Update an existing board by id
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The new name for the board. 1 to 16384 characters long. |
|
|
A new description for the board, 0 to 16384 characters long |
|
|
Whether the board is closed |
|
|
Whether the acting user is subscribed to the board |
|
|
The id of the Workspace the board should be moved to |
|
|
One of: org, private, public |
|
|
Whether Workspace members can join the board themselves |
|
|
Whether card covers should be displayed on this board |
|
|
Determines whether the Voting Power-Up should hide who voted on cards or not. |
|
|
Who can invite people to this board. One of: admins, members |
|
|
Who can vote on this board. One of disabled, members, observers, org, public |
|
|
Who can comment on cards on this board. One of: disabled, members, observers, org, public |
|
|
The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey |
|
|
One of: pirate, regular |
|
|
Determines whether the calendar feed is enabled or not. |
|
|
Name for the green label. 1 to 16384 characters long |
|
|
Name for the yellow label. 1 to 16384 characters long |
|
|
Name for the orange label. 1 to 16384 characters long |
|
|
Name for the red label. 1 to 16384 characters long |
|
|
Name for the purple label. 1 to 16384 characters long |
|
|
Name for the blue label. 1 to 16384 characters long |
|
|
N/A |
PUT Update a Card
/cards/{id}
Update a card. Query parameters may also be replaced with a JSON request body instead.
Parameters
|
Parameter Name |
Description |
||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
N/A |
||||||||||||||||||
|
|
N/A |
||||||||||||||||||
|
|
N/A |
||||||||||||||||||
|
|
The ID of the Card |
||||||||||||||||||
|
|
The new name for the card |
||||||||||||||||||
|
|
The new description for the card |
||||||||||||||||||
|
|
Whether the card should be archived (closed: true) |
||||||||||||||||||
|
|
Comma-separated list of member IDs |
||||||||||||||||||
|
|
The ID of the image attachment the card should use as its cover, or null for none |
||||||||||||||||||
|
|
The ID of the list the card should be in |
||||||||||||||||||
|
|
Comma-separated list of label IDs |
||||||||||||||||||
|
|
The ID of the board the card should be on |
||||||||||||||||||
|
|
The position of the card in its list. top, bottom, or a positive float |
||||||||||||||||||
|
|
When the card is due, or null |
||||||||||||||||||
|
|
The start date of a card, or null |
||||||||||||||||||
|
|
Whether the due date should be marked complete |
||||||||||||||||||
|
|
Whether the member is should be subscribed to the card |
||||||||||||||||||
|
|
For use with/by the Map View |
||||||||||||||||||
|
|
For use with/by the Map View |
||||||||||||||||||
|
|
For use with/by the Map View. Should be latitude,longitude |
||||||||||||||||||
|
|
Updates the card's cover
brightness can be sent alongside any of the other parameters, but all of the other parameters are mutually exclusive; you can not have the cover be a color and an idAttachment at the same time. On the brightness options, setting it to light will make the text on the card cover dark:
And vice versa, setting it to dark will make the text on the card cover light:
|
||||||||||||||||||
|
|
N/A |
PUT Update a Checklist
/checklists/{id}
Update an existing checklist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
Name of the new checklist being created. Should be length of 1 to 16384. |
|
|
Determines the position of the checklist on the card. One of: top, bottom, or a positive number. |
|
|
N/A |
PUT Update a Comment Action
/actions/{id}/text
Update a comment action
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the action to update |
|
|
The new text for the comment |
|
|
N/A |
PUT Update a Custom Field definition
/customFields/{id}
Update a Custom Field definition.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Custom Field. |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The name of the Custom Field |
|
|
Whether to display this custom field on the front of cards |
PUT Update a Label
/labels/{id}
Update a label by ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Label |
|
|
The new name for the label |
|
|
The new color for the label. See: fields for color options |
|
|
N/A |
PUT Update a List
/lists/{id}
Update the properties of a List
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the list |
|
|
New name for the list |
|
|
Whether the list should be closed (archived) |
|
|
ID of a board the list should be moved to |
|
|
New position for the list: top, bottom, or a positive floating point number |
|
|
Whether the active member is subscribed to this list |
|
|
N/A |
PUT Update a Member
/members/{id}
Update a Member
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
New name for the member. Cannot begin or end with a space. |
|
|
New initials for the member. 1-4 characters long. |
|
|
New username for the member. At least 3 characters long, only lowercase letters, underscores, and numbers. Must be unique. |
|
|
N/A |
|
|
One of: gravatar, none, upload |
|
|
N/A |
|
|
N/A |
|
|
-1 for disabled, 1, or 60 |
|
|
N/A |
PUT Update a Member of an Organization
/organizations/{id}/members/{idMember}
Add a member to a Workspace or update their member type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
The ID or username of the member to update |
|
|
One of: admin, normal |
|
|
N/A |
PUT Update a Member's custom Board background
/members/{id}/boardBackgrounds/{idBackground}
Update a board background
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the board background |
|
|
One of: dark, light, unknown |
|
|
Whether the background should be tiled |
|
|
N/A |
PUT Update a Member's licensed status
/enterprises/{id}/members/{idMember}/licensed
This endpoint is used to update whether the provided Member should use one of the Enterprise's available licenses or not. Revoking a license will deactivate a Member of an Enterprise.
NOTE: Revoking of licenses is not possible for enterprises that have opted in to user management via AdminHub.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Enterprise. |
|
|
The ID of the Member |
|
|
Boolean value to determine whether the user should be given an Enterprise license (true) or not (false). |
|
|
N/A |
PUT Update a Notification's read status
/notifications/{id}
Update the read status of a notification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the notification |
|
|
Whether the notification should be marked as read or not |
|
|
N/A |
PUT Update a Plugin
/plugins/{id}/
Update a Plugin
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
N/A |
PUT Update a Sticker on a Card
/cards/{id}/stickers/{idSticker}
Update a sticker on a card
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the sticker |
|
|
The top position of the sticker, from -60 to 100 |
|
|
The left position of the sticker, from -60 to 100 |
|
|
The z-index of the sticker |
|
|
The rotation of the sticker |
|
|
N/A |
PUT Update a Webhook
/webhooks/{id}
Update a webhook by ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the webhook to retrieve. |
|
|
A string with a length from 0 to 16384. |
|
|
A valid URL that is reachable with a HEAD and POST request. |
|
|
ID of the model to be monitored |
|
|
Determines whether the webhook is active and sending POST requests. |
|
|
N/A |
PUT Update a Webhook created by Token
/tokens/{token}/webhooks/{idWebhook}
Update a Webhook created by Token
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Webhooks to retrieve. |
|
|
A description to be displayed when retrieving information about the webhook. |
|
|
The URL that the webhook should POST information to. |
|
|
ID of the object that the webhook is on. |
|
|
N/A |
PUT Update a checkItem on a Card
/cards/{id}/checkItem/{idCheckItem}
Update an item in a checklist on a card.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Card |
|
|
The ID of the checkitem |
|
|
The new name for the checklist item |
|
|
One of: complete, incomplete |
|
|
The ID of the checklist this item is in |
|
|
top, bottom, or a positive float |
|
|
A due date for the checkitem |
|
|
A dueReminder for the due date on the checkitem |
|
|
The ID of the member to remove from the card |
|
|
N/A |
PUT Update a field on a List
/lists/{id}/{field}
Rename a list
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the list |
|
|
The field on the List to be updated |
|
|
The new value for the field |
|
|
N/A |
PUT Update a field on a label
/labels/{id}/{field}
Update a field on a label.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the label |
|
|
The field on the Label to update. |
|
|
The new value for the field. |
|
|
N/A |
PUT Update a saved search
/members/{id}/savedSearches/{idSearch}
Update a saved search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the saved search to delete |
|
|
The new name for the saved search |
|
|
The new search query |
|
|
New position for saves search. top, bottom, or a positive float. |
|
|
N/A |
PUT Update an Action
/actions/{id}
Update a specific Action. Only comment actions can be updated. Used to edit the content of a comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Action |
|
|
The new text for the comment |
|
|
N/A |
PUT Update an Organization
/organizations/{id}
Update an organization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the Organization |
|
|
A new name for the organization. At least 3 lowercase letters, underscores, and numbers. Must be unique |
|
|
A new displayName for the organization. Must be at least 1 character long and not begin or end with a space. |
|
|
A new description for the organization |
|
|
A URL starting with http://, https://, or null |
|
|
The Google Apps domain to link this org to. |
|
|
Whether non-workspace members can be added to boards inside the Workspace |
|
|
1 or 2 |
|
|
Who on the Workspace can make Workspace visible boards. One of admin, none, org |
|
|
Who can make private boards. One of: admin, none, org |
|
|
Who on the Workspace can make public boards. One of: admin, none, org |
|
|
An email address with optional wildcard characters. (E.g. subdomain.*.trello.com) |
|
|
Whether the Workspace page is publicly visible. One of: private, public |
|
|
N/A |
PUT Update an Organization's Members
/organizations/{id}/members
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the organization |
|
|
An email address |
|
|
Name for the member, at least 1 character not beginning or ending with a space |
|
|
One of: admin, normal |
|
|
N/A |
PUT Update blocked notification keys of Member on a channel
/members/{id}/notificationsChannelSettings
Update blocked notification keys of Member on a specific channel
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update blocked notification keys of Member on a channel
/members/{id}/notificationsChannelSettings/{channel}
Update blocked notification keys of Member on a specific channel
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
Channel to block notifications on |
|
|
N/A |
PUT Update blocked notification keys of Member on a channel
/members/{id}/notificationsChannelSettings/{channel}/{blockedKeys}
Update blocked notification keys of Member on a specific channel
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
Channel to block notifications on |
|
|
Singular key or comma-separated list of notification keys |
|
|
N/A |
PUT Update custom Board Background of Member
/members/{id}/customBoardBackgrounds/{idBackground}
Update a specific custom board background
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the custom background |
|
|
One of: dark, light, unknown |
|
|
Whether to tile the background |
|
|
N/A |
PUT Update emailPosition Pref on a Board
/boards/{id}/myPrefs/emailPosition
Update emailPosition Pref on a Board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
Valid values: bottom, top. Determines the position of the email address. |
|
|
N/A |
PUT Update field on a Checklist
/checklists/{id}/{field}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of a checklist. |
|
|
Field to update. |
|
|
The value to change the checklist name to. Should be a string of length 1 to 16384. |
|
|
N/A |
PUT Update idEmailList Pref on a Board
/boards/{id}/myPrefs/idEmailList
Change the default list that email-to-board cards are created in.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
The id of an email list. |
|
|
N/A |
POST Update logo for an Organization
/organizations/{id}/logo
Set the logo image for a Workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or name of the Workspace |
|
|
Image file for the logo |
|
|
N/A |
PUT Update showListGuide Pref on a Board
/boards/{id}/myPrefs/showListGuide
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
Determines whether to show the list guide. |
|
|
N/A |
PUT Update showSidebar Pref on a Board
/boards/{id}/myPrefs/showSidebar
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
Determines whether to show the side bar. |
|
|
N/A |
PUT Update showSidebarActivity Pref on a Board
/boards/{id}/myPrefs/showSidebarActivity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
Determines whether to show sidebar activity. |
|
|
N/A |
PUT Update showSidebarBoardActions Pref on a Board
/boards/{id}/myPrefs/showSidebarBoardActions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
Determines whether to show the sidebar board actions. |
|
|
N/A |
PUT Update showSidebarMembers Pref on a Board
/boards/{id}/myPrefs/showSidebarMembers
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the board to update |
|
|
Determines whether to show members of the board in the sidebar. |
|
|
N/A |
PUT Update the position of a boardStar of Member
/members/{id}/boardStars/{idStar}
Update the position of a starred board
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
The ID of the board star |
|
|
New position for the starred board. top, bottom, or a positive float. |
|
|
N/A |
PUT Updating Plugin's Listing
/plugins/{idPlugin}/listings/{idListing}
Update an existing listing for your Power-Up
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the Power-Up whose listing is being updated. |
|
|
The ID of the existing listing for the Power-Up that is being updated. |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The description to show for the given locale |
|
|
The locale that this listing should be displayed for. |
|
|
The overview to show for the given locale. |
|
|
The name to use for the given locale. |
POST Upload new boardBackground for Member
/1/members/me/boards
Upload a new boardBackground
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
|
|
N/A |
POST Upload new boardBackground for Member
/members/{id}/boardBackgrounds
Upload a new boardBackground
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or username of the member |
|
|
N/A |
|
|
N/A |