Trelloconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 259 actions for the Trelloconnector v1.0.

General (259)

POST Add Member vote to Card

/cards/{id}/membersVoted

Vote on the card for a given member.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Value`	The ID of the member to vote 'yes' on the card
`Response Type`	The response format expected from the API (e.g. application/json).

POST Add Option to Custom Field dropdown

/customFields/{id}/options

Add an option to a dropdown Custom Field

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the customfield.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Add a Label to a Card

/cards/{id}/idLabels

Add a label to a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Value`	The ID of the label to add
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Add a Member to a Board

/boards/{id}/members/{idMember}

Add a member to the board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Idmember`	The id of the member to add to the board.
`Type`	One of: admin, normal, observer. Determines the type of member this user will be on the board.
`Allowbillableguest`	Optional param that allows organization admins to add multi-board guests onto a board.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Add a Member to a Card

/cards/{id}/idMembers

Add a member to a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Value`	The ID of the Member to add to the card
`Response Type`	The response format expected from the API (e.g. application/json).

POST Add a Sticker to a Card

/cards/{id}/stickers

Add a sticker to a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Image`	For custom stickers, the id of the sticker. For default stickers, the string identifier (like 'taco-cool', see below)
`Top`	The top position of the sticker, from -60 to 100
`Left`	The left position of the sticker, from -60 to 100
`Zindex`	The z-index of the sticker
`Rotate`	The rotation of the sticker
`Response Type`	The response format expected from the API (e.g. application/json).

POST Add a new comment to a Card

/cards/{id}/actions/comments

Add a new comment to a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Text`	The comment
`Response Type`	The response format expected from the API (e.g. application/json).

POST Archive all Cards in List

/lists/{id}/archiveAllCards

Archive all cards in a list

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the list
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Archive or unarchive a list

/lists/{id}/closed

Archive or unarchive a list

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the list
`Value`	Set to true to close (archive) the list
`Response Type`	The response format expected from the API (e.g. application/json).

GET Batch Requests

/batch

Make up to 10 GET requests in a single, batched API call.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Urls`	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]"
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Idorganizations`	An array of IDs of the organizations to be removed from the enterprise.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create Attachment On Card

/cards/{id}/attachments

Create an Attachment to a Card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Name`	The name of the attachment. Max length 256.
`File`	The file to attach, as multipart/form-data
`Mimetype`	The mimeType of the attachment. Max length 256
`Url`	A URL to attach. Must start with http:// or https://
`Setcover`	Determines whether to use the new attachment as a cover for the Card.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create Avatar for Member

/members/{id}/avatar

Create a new avatar for a member

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`File`	The file data of the avatar image to upload.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create Checkitem on Checklist

/checklists/{id}/checkItems

Add a new check item to an existing checklist. Use this to create a task item within a checklist on a card.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Name`	The name of the new check item on the checklist. Should be a string of length 1 to 16384.
`Pos`	The position of the check item in the checklist. One of: top, bottom, or a positive number.
`Checked`	Determines whether the check item is already checked when created.
`Due`	A due date for the checkitem
`Duereminder`	A dueReminder for the due date on the checkitem
`Idmember`	An ID of a member resource.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create Checklist on a Card

/cards/{id}/checklists

Create a new checklist on a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Name`	The name of the checklist
`Idchecklistsource`	The ID of a source checklist to copy into the new one
`Pos`	The position of the checklist on the card. One of: top, bottom, or a positive number.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create Export for Organizations

/organizations/{id}/exports

Kick off CSV export for an organization

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the Workspace
`Attachments`	Whether the CSV should include attachments or not.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create Reaction for Action

/actions/{idAction}/reactions

Adds a new reaction to an action

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idaction`	The ID of the action
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Shortname`	The primary shortName of the emoji to add. See /emoji
`Skinvariation`	The skinVariation of the emoji to add. See /emoji
`Native`	The emoji to add as a native unicode emoji. See /emoji
`Unified`	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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idboard`	The ID of the board to star
`Pos`	The position of the newly starred board. top, bottom, or a positive float.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create Webhooks for Token

/tokens/{token}/webhooks

Create a new webhook for a Token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	The application token to associate the webhook with.
`Description`	A description to be displayed when retrieving information about the webhook.
`Callbackurl`	The URL that the webhook should POST information to.
`Idmodel`	ID of the object to create a webhook on.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a Board

/boards/

Create a new board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Name`	The new name for the board. 1 to 16384 characters long.
`Defaultlabels`	Determines whether to use the default set of labels.
`Defaultlists`	Determines whether to add the default set of lists to a board (To Do, Doing, Done). It is ignored if idBoardSource is provided.
`Desc`	A new description for the board, 0 to 16384 characters long
`Idorganization`	The id or name of the Workspace the board should belong to.
`Idboardsource`	The id of a board to copy into the new board.
`Keepfromsource`	To keep cards from the original board pass in the value cards
`Powerups`	The Power-Ups that should be enabled on the new board. One of: all, calendar, cardAging, recap, voting.
`Prefs Permissionlevel`	The permissions level of the board. One of: org, private, public.
`Prefs Voting`	Who can vote on this board. One of disabled, members, observers, org, public.
`Prefs Comments`	Who can comment on cards on this board. One of: disabled, members, observers, org, public.
`Prefs Invitations`	Determines what types of members can invite users to join. One of: admins, members.
`Prefs Selfjoin`	Determines whether users can join the boards themselves or whether they have to be invited.
`Prefs Cardcovers`	Determines whether card covers are enabled.
`Prefs Background`	The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey.
`Prefs Cardaging`	Determines the type of card aging that should take place on the board if card aging is enabled. One of: pirate, regular.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a Checklist

/checklists

Create a new checklist on a card. Use this to add a checklist that can contain check items.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idcard`	The ID of the Card that the checklist should be added to.
`Name`	The name of the checklist. Should be a string of length 1 to 16384.
`Pos`	The position of the checklist on the card. One of: top, bottom, or a positive number.
`Idchecklistsource`	The ID of a checklist to copy into the new checklist.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a Label

/labels

Create a new Label on a Board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Name`	Name for the label
`Color`	The color for the label.
`Idboard`	The ID of the Board to create the Label on.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a Label on a Board

/boards/{id}/labels

Create a new Label on a Board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Name`	The name of the label to be created. 1 to 16384 characters long.
`Color`	Sets the color of the new label. Valid values are a label color or null.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a List on a Board

/boards/{id}/lists

Create a new List on a Board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Name`	The name of the list to be created. 1 to 16384 characters long.
`Pos`	Determines the position of the list. Valid values: top, bottom, or a positive number.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idplugin`	The ID of the Power-Up for which you are creating a new listing.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Description`	The description to show for the given locale
`Locale`	The locale that this listing should be displayed for.
`Overview`	The overview to show for the given locale.
`Name`	The name to use for the given locale.

POST Create a Tag for a Board

/boards/{id}/idTags

Add a tag to a board. Use this to label the board with a custom tag for organization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Value`	The id of a tag from the organization to which this board belongs.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a Tag in Organization

/organizations/{id}/tags

Create a Tag in an Organization

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the Organization
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a Webhook

/webhooks/

Create a new webhook.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Description`	A string with a length from 0 to 16384.
`Callbackurl`	A valid URL that is reachable with a HEAD and POST request.
`Idmodel`	ID of the model to be monitored
`Active`	Determines whether the webhook is active and sending POST requests.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a calendarKey for a Board

/boards/{id}/calendarKey/generate

Create a new board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a emailKey for a Board

/boards/{id}/emailKey/generate

Generate a new email key for a board. Use this to allow emailing cards to the board via a unique email address.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Name`	The name for the card
`Desc`	The description for the card
`Pos`	The position of the new card. top, bottom, or a positive float
`Due`	A due date for the card
`Start`	The start date of a card, or null
`Duecomplete`	Whether the card's due date is marked as complete.
`Idlist`	The ID of the list the card should be created in
`Idmembers`	Comma-separated list of member IDs to add to the card
`Idlabels`	Comma-separated list of label IDs to add to the card
`Urlsource`	A URL starting with http:// or https://
`Filesource`	The source file to attach to the card, specified as a URL or file path.
`Mimetype`	The mimeType of the attachment. Max length 256
`Idcardsource`	The ID of a card to copy into the new card
`Keepfromsource`	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
`Address`	For use with/by the Map View
`Locationname`	For use with/by the Map View
`Coordinates`	For use with/by the Map View. Should take the form latitude,longitude
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a new Custom Field on a Board

/customFields

Create a new Custom Field on a board.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Idmodel`	The ID of the model (board or card) to associate the custom field with.
`Modeltype`	The type of model that the Custom Field is being defined on. This should always be board.
`Name`	The name of the Custom Field
`Type`	The type of Custom Field to create.
`Options`	If the type is checkbox
`Display Cardfront`	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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Color`	A valid label color or null. See labels
`Name`	A name for the label
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a new List

/lists

Create a new List on a Board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Name`	Name for the list
`Idboard`	The long ID of the board the list should be created on
`Idlistsource`	ID of the List to copy into the new List
`Pos`	Position of the list. top, bottom, or a positive floating point number
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a new Organization

/organizations

Create a new Workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Displayname`	The name to display for the Organization
`Desc`	The description for the organizations
`Name`	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.
`Website`	A URL starting with http:// or https://
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a new custom Board Background

/members/{id}/customBoardBackgrounds

Upload a new custom board background

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`File`	The file data of the background image to upload.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create an auth Token for an Enterprise.

/enterprises/{id}/tokens

Create an auth Token for an Enterprise.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Expiration`	One of: 1hour, 1day, 30days, never
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create custom Emoji for Member

/members/{id}/customEmoji

Create a new custom Emoji

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`File`	The file data of the emoji image to upload.
`Name`	Name for the emoji. 2 - 64 characters
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create custom Sticker for Member

/members/{id}/customStickers

Upload a new custom sticker

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`File`	The file data of the sticker image to upload.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create saved Search for Member

/members/{id}/savedSearches

Create a saved search

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Name`	The name for the saved search
`Query`	The search query
`Pos`	The position of the saved search. top, bottom, or a positive float.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Idmember`	ID of the Member to deactive.
`Value`	Determines whether the user is deactivated or not.
`Fields`	A comma separated list of any valid values that the [nested member field resource]() accepts.
`Organization Fields`	Any valid value that the nested organization resource accepts.
`Board Fields`	Any valid value that the nested board resource accepts.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Idmember`	The ID or username of the member to update
`Value`	Set to true to deactivate the member or false to reactivate.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Enterprise to retrieve.
`Idorganizations`	An array of IDs of an Organization resource.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete Action's Reaction

/actions/{idAction}/reactions/{id}

Deletes a reaction

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idaction`	The ID of the Action
`Id`	The ID of the reaction
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete Checkitem from Checklist

/checklists/{id}/checkItems/{idCheckItem}

Remove an item from a checklist

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Idcheckitem`	ID of the check item to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete Logo for Organization

/organizations/{id}/logo

Delete a the logo from a Workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete Option of Custom Field dropdown

/customFields/{id}/options/{idCustomFieldOption}

Delete an option from a Custom Field dropdown.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the customfielditem.
`Idcustomfieldoption`	ID of the customfieldoption to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete Star for Board

/members/{id}/boardStars/{idStar}

Unstar a board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idstar`	The ID of the board star
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Board

/boards/{id}

Delete a board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to delete
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Card

/cards/{id}

Delete a Card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Checklist

/checklists/{id}

Delete a checklist

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Checklist on a Card

/cards/{id}/checklists/{idChecklist}

Delete a checklist from a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idchecklist`	The ID of the checklist to delete
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Custom Field definition

/customFields/{id}

Delete a Custom Field from a board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Custom Field.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Label

/labels/{id}

Delete a label by ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Label
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Member's custom Board background

/members/{id}/boardBackgrounds/{idBackground}

Delete a board background

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idbackground`	The ID of the board background
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Member's custom Sticker

/members/{id}/customStickers/{idSticker}

Delete a Member's custom Sticker

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idsticker`	The ID of the uploaded sticker
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Sticker on a Card

/cards/{id}/stickers/{idSticker}

Remove a sticker from the card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idsticker`	The ID of the sticker
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Token

/tokens/{token}/

Delete a token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	The token to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Webhook

/webhooks/{id}

Delete a webhook by ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the webhook to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Webhook created by Token

/tokens/{token}/webhooks/{idWebhook}

Delete a webhook created with given token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	The token that owns the webhook to delete.
`Idwebhook`	ID of the Webhooks to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a comment on a Card

/cards/{id}/actions/{idAction}/comments

Delete a comment

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idaction`	The ID of the comment action to update
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a saved search

/members/{id}/savedSearches/{idSearch}

Delete a saved search

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idsearch`	The ID of the saved search to delete
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete an Action

/actions/{id}

Delete a specific action. Only comment actions can be deleted.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Action
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete an Attachment on a Card

/cards/{id}/attachments/{idAttachment}

Delete an Attachment

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idattachment`	The ID of the attachment to delete
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete an Organization

/organizations/{id}

Delete an Organization

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the Organization
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete an Organization from an Enterprise.

/enterprises/{id}/organizations/{idOrg}

Remove an organization from an enterprise.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Idorg`	ID of the organization to be removed from the enterprise.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete an Organization's Tag

/organizations/{id}/tags/{idTag}

Delete an organization's tag

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Idtag`	The ID of the tag to delete
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete checkItem on a Card

/cards/{id}/checkItem/{idCheckItem}

Delete a checklist item

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idcheckitem`	The ID of the checkitem
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete custom Board Background of Member

/members/{id}/customBoardBackgrounds/{idBackground}

Delete a specific custom board background

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idbackground`	The ID of the custom background
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Disable a Power-Up on a Board

/boards/{id}/boardPlugins/{idPlugin}

Disable a Power-Up on a board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Idplugin`	The ID of the Power-Up to disable
`Response Type`	The response format expected from the API (e.g. application/json).

POST Dismiss a message for Member

/members/{id}/oneTimeMessagesDismissed

Dismiss a message

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Value`	The message to dismiss
`Response Type`	The response format expected from the API (e.g. application/json).

POST Enable a Power-Up on a Board

/boards/{id}/boardPlugins

Enable a Power-Up on a Board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Board
`Idplugin`	The ID of the Power-Up to enable
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Action's Reaction

/actions/{idAction}/reactions/{id}

Get information for a reaction

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idaction`	The ID of the Action
`Id`	The ID of the reaction
`Member`	Whether to load the member as a nested resource. See Members Nested Resource
`Emoji`	Whether to load the emoji as a nested resource.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Action's Reactions

/actions/{idAction}/reactions

List reactions for an action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idaction`	The ID of the action
`Member`	Whether to load the member as a nested resource. See Members Nested Resource
`Emoji`	Whether to load the emoji as a nested resource.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Actions for Organization

/organizations/{id}/actions

List the actions on a Workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Actions for a List

/lists/{id}/actions

Get the Actions on a List

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the list
`Filter`	A comma-separated list of action types.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Actions of a Board

/boards/{boardId}/actions

Retrieve a list of actions (activity log) for a board. Use this to see changes, comments, and other events on the board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Boardid`	The ID of the board whose actions to retrieve.
`Fields`	The fields to be returned for the Actions. See Action fields here.
`Filter`	A comma-separated list of action types.
`Format`	The format of the returned Actions. Either list or count.
`Idmodels`	A comma-separated list of idModels. Only actions related to these models will be returned.
`Limit`	The limit of the number of responses, between 0 and 1000.
`Member`	Whether to return the member object for each action.
`Member Fields`	The fields of the member to return.
`Membercreator`	Whether to return the memberCreator object for each action.
`Membercreator Fields`	The fields of the member creator to return
`Page`	The page of results for actions.
`Reactions`	Whether to show reactions on comments or not.
`Before`	An Action ID
`Since`	An Action ID
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Actions on a Card

/cards/{id}/actions

List the Actions on a Card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Filter`	A comma-separated list of action types.
`Page`	The page of results for actions. Each page of results has 50 actions.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Application's compliance data

/applications/{key}/compliance

Fetch compliance information for an application. Use this to verify that the application meets data protection requirements.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key`	The application's API key.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Attachments on a Card

/cards/{id}/attachments

List the attachments on a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Fields`	all or a comma-separated list of attachment fields
`Filter`	Use cover to restrict to just the cover attachment
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Boards in an Organization

/organizations/{id}/boards

List the boards in a Workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Filter`	all or a comma-separated list of: open, closed, members, organization, public
`Fields`	all or a comma-separated list of board fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Boards that Member belongs to

/members/{id}/boards

Lists the boards that the user is a member of.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Filter`	all or a comma-separated list of: closed, members, open, organization, public, starred
`Fields`	all or a comma-separated list of board fields
`Lists`	Which lists to include with the boards. One of: all, closed, none, open
`Organization`	Whether to include the Organization object with the Boards
`Organization Fields`	all or a comma-separated list of organization fields
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Fields`	all or a comma-separated list of board fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Cards in a List

/lists/{id}/cards

List the cards in a list

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the list
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Cards on a Board

/boards/{id}/cards

Get all of the open Cards on a Board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board whose cards to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Cards the Member is on

/members/{id}/cards

Gets the cards a member is on

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Filter`	One of: all, closed, none, open, visible
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Checkitems on a Checklist

/checklists/{id}/checkItems

Retrieve all check items within a checklist. Use this to see the list of tasks in the checklist.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Filter`	One of: all, none.
`Fields`	One of: all, name, nameData, pos, state,type, due, dueReminder, idMember.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Checklists on a Board

/boards/{id}/checklists

Get all of the checklists on a Board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Checklists on a Card

/cards/{id}/checklists

Get the checklists on a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Checkitems`	all or none
`Checkitem Fields`	all or a comma-separated list of: name,nameData,pos,state,type,due,dueReminder,idMember
`Filter`	all or none
`Fields`	all or a comma-separated list of: idBoard,idCard,name,pos
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve
`Limit`	Limits the number of workspaces to be sorted
`Cursor`	Specifies the sort order to return matching documents
`Name`	Name of the enterprise to retrieve workspaces for
`Activesince`	Date in YYYY-MM-DD format indicating the date to search up to for activeness of workspace
`Inactivesince`	Date in YYYY-MM-DD format indicating the date to search up to for inactiveness of workspace
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Custom Field Items for a Card

/cards/{id}/customFieldItems

Get the custom field items for a card.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Custom Fields for Board

/boards/{id}/customFields

Get the Custom Field Definitions that exist on a board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Enabled Power-Ups on Board

/boards/{id}/boardPlugins

Get the enabled Power-Ups on a board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Board
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Enterprise admin Members

/enterprises/{id}/admins

Get an enterprise's admin members.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Fields`	Any valid value that the [nested member field resource]() accepts.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Labels on a Board

/boards/{id}/labels

Get all of the Labels on a Board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Board.
`Fields`	The fields to be returned for the Labels.
`Limit`	The number of Labels to be returned.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Lists on a Board

/boards/{id}/lists

Get the Lists on a Board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Cards`	Filter to apply to Cards.
`Card Fields`	all or a comma-separated list of card fields
`Filter`	Filter to apply to Lists
`Fields`	all or a comma-separated list of list fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Member's Boards New

/1/members/me/boards

Get Member's Boards New

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filter`	One of: all, custom, default, none, premium
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Member's Notifications

/members/{id}/notifications

Get a member's notifications

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Entities`	Include entity objects in the response.
`Display`	Include display data for the notifications.
`Filter`	Filter notifications by type (e.g., "all", "mention").
`Read Filter`	One of: all, read, unread
`Fields`	all or a comma-separated list of notification fields
`Limit`	Max 1000
`Page`	Max 100
`Before`	A notification ID
`Since`	A notification ID
`Membercreator`	Include the member who triggered the notification.
`Membercreator Fields`	all or a comma-separated list of member fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Member's Organizations

/members/{id}/organizations

Get a member's Workspaces

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Filter`	One of: all, members, none, public (Note: members filters to only private Workspaces)
`Fields`	all or a comma-separated list of organization fields
`Paid Account`	Whether or not to include paid account information in the returned workspace object
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Member's Tokens

/members/{id}/tokens

List a members app tokens

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Webhooks`	Whether to include webhooks
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Member's custom Board backgrounds

/members/{id}/boardBackgrounds

Get a member's custom board backgrounds

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Filter`	One of: all, custom, default, none, premium
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Member's custom Stickers

/members/{id}/customStickers

Get a Member's uploaded stickers

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Member's saved searched

/members/{id}/savedSearches

List the saved searches of a Member

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Members of Enterprise

/enterprises/{id}/members

Get the members of an enterprise.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Enterprise to retrieve.
`Fields`	A comma-seperated list of valid member fields.
`Filter`	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.
`Sort`	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.
`Sortby`	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.
`Sortorder`	Deprecated: Please use sort instead. One of: ascending, descending, asc, desc.
`Startindex`	Any integer between 0 and 9999.
`Count`	SCIM-style filter.
`Organization Fields`	Any valid value that the nested organization field resource accepts.
`Board Fields`	Any valid value that the nested board resource accepts.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Fields`	all or a comma-separated list of member fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Memberships of a Board

/boards/{id}/memberships

Get information about the memberships users have to the board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Filter`	One of admins, all, none, normal
`Activity`	Works for premium organizations only.
`Orgmembertype`	Shows the type of member to the org the user is. For instance, an org admin will have a orgMemberType of admin.
`Member`	Determines whether to include a nested member object.
`Member Fields`	Fields to show if member=true. Valid values: nested member resource fields.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Memberships of an Organization

/organizations/{id}/memberships

List the memberships of a Workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Filter`	all or a comma-separated list of: active, admin, deactivated, me, normal
`Member`	Whether to include the Member objects with the Memberships
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the customfielditem.
`Idcustomfieldoption`	ID of the customfieldoption to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Options of Custom Field drop down

/customFields/{id}/options

Get the options of a drop down Custom Field

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the customfield.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Fields`	all or a comma-separated list of organization fields
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Idboard`	The ID of the board to check for new billable guests.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get PendingOrganizations of an Enterprise

/enterprises/{id}/pendingOrganizations

Get the Workspaces that are pending for the enterprise by ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve
`Activesince`	Date in YYYY-MM-DD format indicating the date to search up to for activeness of workspace
`Inactivesince`	Date in YYYY-MM-DD format indicating the date to search up to for inactiveness of workspace
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Plugin's Member privacy compliance

/plugins/{id}/compliance/memberPrivacy

Check a plugin's compliance with member privacy regulations. Use this to ensure the plugin handles member data appropriately.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Power-Up
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Power-Ups on a Board

/boards/{id}/plugins

List the Power-Ups on a board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Filter`	One of: enabled or available
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Stickers on a Card

/cards/{id}/stickers

Get the stickers on a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Fields`	all or a comma-separated list of sticker fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Tags of an Organization

/organizations/{id}/tags

List the organization's collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the Organization
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Token's Member

/tokens/{token}/member

Retrieve information about a token's owner by token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	The token to look up the member for.
`Fields`	all or a comma-separated list of valid fields for Member Object.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Licensed`	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.
`Deactivated`	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.
`Collaborator`	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.
`Managed`	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.
`Admin`	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.
`Activesince`	Returns only Trello users active since this date (inclusive).
`Inactivesince`	Returns only Trello users active since this date (inclusive).
`Search`	Returns members with email address or full name that start with the search value.
`Startindex`	Cursor to return next set of results
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Webhooks for Token

/tokens/{token}/webhooks

Retrieve all webhooks created with a Token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	The token whose webhooks to fetch.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Board

/boards/{id}

Request a single board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board to retrieve.
`Actions`	This is a nested resource. Read more about actions as nested resources here.
`Boardstars`	Valid values are one of: mine or none.
`Cards`	This is a nested resource. Read more about cards as nested resources here.
`Card Plugindata`	Use with the cards param to include card pluginData with the response
`Checklists`	This is a nested resource. Read more about checklists as nested resources here.
`Customfields`	This is a nested resource. Read more about custom fields as nested resources here.
`Fields`	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
`Labels`	This is a nested resource. Read more about labels as nested resources here.
`Lists`	This is a nested resource. Read more about lists as nested resources here.
`Members`	This is a nested resource. Read more about members as nested resources here.
`Memberships`	This is a nested resource. Read more about memberships as nested resources here.
`Plugindata`	Determines whether the pluginData for this board should be returned. Valid values: true or false.
`Organization`	This is a nested resource. Read more about organizations as nested resources here.
`Organization Plugindata`	Use with the organization param to include organization pluginData with the response
`Myprefs`	Include the requesting member's preferences for the board.
`Tags`	Also known as collections, tags, refer to the collection(s) that a Board belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Card

/cards/{id}

Get a card by its ID

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Fields`	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
`Actions`	See the Actions Nested Resource
`Attachments`	true, false, or cover
`Attachment Fields`	all or a comma-separated list of attachment fields
`Members`	Whether to return member objects for members on the card
`Member Fields`	all or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username
`Membersvoted`	Whether to return member objects for members who voted on the card
`Membervoted Fields`	all or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username
`Checkitemstates`	Include the completion states of check items on the card.
`Checklists`	Whether to return the checklists on the card. all or none
`Checklist Fields`	all or a comma-separated list of idBoard,idCard,name,pos
`Board`	Whether to return the board object the card is on
`Board Fields`	all or a comma-separated list of board fields. Defaults: name, desc, descData, closed, idOrganization, pinned, url, prefs
`List`	See the Lists Nested Resource
`Plugindata`	Whether to include pluginData on the card with the response
`Stickers`	Whether to include sticker models with the response
`Sticker Fields`	all or a comma-separated list of sticker fields
`Customfielditems`	Whether to include the customFieldItems
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Card on a Board

/boards/{id}/cards/{idCard}

Get a single Card on a Board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Idcard`	The id the card to retrieve.
`Fields`	The fields to be returned for the Actions. See Action fields here.
`Filter`	A comma-separated list of action types.
`Format`	The format of the returned Actions. Either list or count.
`Idmodels`	A comma-separated list of idModels. Only actions related to these models will be returned.
`Limit`	The limit of the number of responses, between 0 and 1000.
`Member`	Whether to return the member object for each action.
`Member Fields`	The fields of the member to return.
`Membercreator`	Whether to return the memberCreator object for each action.
`Membercreator Fields`	The fields of the member creator to return
`Page`	The page of results for actions.
`Reactions`	Whether to show reactions on comments or not.
`Before`	An Action ID
`Since`	An Action ID
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Checkitem on a Checklist

/checklists/{id}/checkItems/{idCheckItem}

Retrieve a specific check item from a checklist. Use this to get details of a single task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Idcheckitem`	ID of the check item to retrieve.
`Fields`	One of: all, name, nameData, pos, state, type, due, dueReminder, idMember,.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Checklist

/checklists/{id}

Retrieve a specific checklist by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Cards`	Valid values: all, closed, none, open, visible. Cards is a nested resource. The additional query params available are documented at Cards Nested Resource.
`Checkitems`	The check items on the list to return. One of: all, none.
`Checkitem Fields`	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
`Fields`	all or a comma-separated list of checklist fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Custom Field

/customFields/{id}

Retrieve details of a specific custom field definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Custom Field.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Label

/labels/{id}

Get information about a single Label.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Label
`Fields`	all or a comma-separated list of fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a List

/lists/{id}

Get information about a List

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the list
`Fields`	all or a comma separated list of List field names.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Member

/members/{id}

Get a member

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Actions`	See the Actions Nested Resource
`Boards`	See the Boards Nested Resource
`Boardbackgrounds`	One of: all, custom, default, none, premium
`Boardsinvited`	all or a comma-separated list of: closed, members, open, organization, pinned, public, starred, unpinned
`Boardsinvited Fields`	all or a comma-separated list of board fields
`Boardstars`	Whether to return the boardStars or not
`Cards`	See the Cards Nested Resource for additional options
`Customboardbackgrounds`	all or none
`Customemoji`	all or none
`Customstickers`	all or none
`Fields`	all or a comma-separated list of member fields
`Notifications`	See the Notifications Nested Resource
`Organizations`	One of: all, members, none, public
`Organization Fields`	all or a comma-separated list of organization fields
`Organization Paid Account`	Whether or not to include paid account information in the returned workspace object
`Organizationsinvited`	One of: all, members, none, public
`Organizationsinvited Fields`	all or a comma-separated list of organization fields
`Paid Account`	Whether or not to include paid account information in the returned member object
`Savedsearches`	Indicates whether to include the member's saved searches in the response; set to true to include them.
`Tokens`	all or none
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Member of Enterprise

/enterprises/{id}/members/{idMember}

Get a specific member of an enterprise by ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Idmember`	An ID of a member resource.
`Fields`	A comma separated list of any valid values that the [nested member field resource]() accepts.
`Organization Fields`	Any valid value that the nested organization field resource accepts.
`Board Fields`	Any valid value that the nested board resource accepts.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Member's Actions

/members/{id}/actions

List the actions for a member

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Filter`	A comma-separated list of action types.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Member's boardStars

/members/{id}/boardStars

List a member's board stars

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Member's custom Board Backgrounds

/members/{id}/customBoardBackgrounds

Get a member's custom board backgrounds

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Member's custom Emoji

/members/{id}/customEmoji/{idEmoji}

Get a Member's custom Emoji

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idemoji`	The ID of the custom emoji
`Fields`	all or a comma-separated list of name, url
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Member's custom Sticker

/members/{id}/customStickers/{idSticker}

Get a Member's custom Sticker

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idsticker`	The ID of the uploaded sticker
`Fields`	all or a comma-separated list of scaled, url
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Member's customEmojis

/members/{id}/customEmoji

Get a Member's uploaded custom Emojis

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Member's notification channel settings

/members/{id}/notificationsChannelSettings

Get a member's notification channel settings

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Membership of an Organization

/organizations/{id}/memberships/{idMembership}

Get a single Membership for an Organization

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Idmembership`	The ID of the membership to load
`Member`	Whether to include the Member object in the response
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Notification

/notifications/{id}

Retrieve a specific notification by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification
`Board`	Whether to include the board object
`Board Fields`	all or a comma-separated list of board fields
`Card`	Whether to include the card object
`Card Fields`	all or a comma-separated list of card fields
`Display`	Whether to include the display object with the results
`Entities`	Whether to include the entities object with the results
`Fields`	all or a comma-separated list of notification fields
`List`	Whether to include the list object
`Member`	Whether to include the member object
`Member Fields`	all or a comma-separated list of member fields
`Membercreator`	Whether to include the member object of the creator
`Membercreator Fields`	all or a comma-separated list of member fields
`Organization`	Whether to include the organization object
`Organization Fields`	all or a comma-separated list of organization fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Notification's associated Organization

/notifications/{id}/organization

Get the organization a notification is associated with

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification
`Fields`	all or a comma-separated list of organization fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Plugin

/plugins/{id}/

Get plugins

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Sticker on a Card

/cards/{id}/stickers/{idSticker}

Get a specific sticker on a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idsticker`	The ID of the sticker
`Fields`	all or a comma-separated list of sticker fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Token

/tokens/{token}

Retrieve information about a token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	The token whose webhooks to fetch.
`Fields`	all or a comma-separated list of dateCreated, dateExpires, idMember, identifier, permissions
`Webhooks`	Determines whether to include webhooks.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the webhook to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a Webhook belonging to a Token

/tokens/{token}/webhooks/{idWebhook}

Retrieve a webhook created with a Token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	The token whose webhooks to fetch.
`Idwebhook`	ID of the Webhooks to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a boardBackground of a Member

/members/{id}/boardBackgrounds/{idBackground}

Get a member's board background

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idbackground`	The ID of the board background
`Fields`	all or a comma-separated list of: brightness, fullSizeUrl, scaled, tile
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a boardStar of Member

/members/{id}/boardStars/{idStar}

Get a specific boardStar

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idstar`	The ID of the board star
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Enterprise to retrieve.
`Idorganizations`	An array of IDs of an Organization resource.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a field of a Notification

/notifications/{id}/{field}

Get a specific property of a notification

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification
`Field`	A notification field
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a field on a Board

/boards/{id}/{field}

Get a single, specific field on a board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board.
`Field`	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.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a field on a Card

/cards/{id}/{field}

Get a specific property of a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Field`	The desired field.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a field on a Member

/members/{id}/{field}

Get a particular property of a member

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Field`	One of the member fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a field on a Webhook

/webhooks/{id}/{field}

Get a field on a Webhook

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the webhook.
`Field`	Field to retrieve. One of: active, callbackURL, description, idModel
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a saved search

/members/{id}/savedSearches/{idSearch}

Get a saved search

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idsearch`	The ID of the saved search to delete
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a specific field on an Action

/actions/{id}/{field}

Get a specific property of an action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Action
`Field`	An action field
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get an Action

/actions/{id}

Get an Action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Action
`Display`	Include display data for the notifications.
`Entities`	Include entity objects in the response.
`Fields`	all or a comma-separated list of action fields
`Member`	Indicates whether to include the member who performed the action; set to true to include member details.
`Member Fields`	all or a comma-separated list of member fields
`Membercreator`	Whether to include the member object for the creator of the action
`Membercreator Fields`	all or a comma-separated list of member fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get an Attachment on a Card

/cards/{id}/attachments/{idAttachment}

Get a specific Attachment on a Card.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idattachment`	The ID of the Attachment
`Fields`	The Attachment fields to be included in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get an Enterprise

/enterprises/{id}

Get an enterprise by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Fields`	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
`Members`	One of: none, normal, admins, owners, all
`Member Fields`	One of: avatarHash, fullName, initials, username
`Member Filter`	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.
`Member Sort`	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.
`Member Sortby`	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.
`Member Sortorder`	Deprecated: Please use member_sort. One of: ascending, descending, asc, desc
`Member Startindex`	Any integer between 0 and 100.
`Member Count`	0 to 100
`Organizations`	One of: none, members, public, all
`Organization Fields`	Any valid value that the [nested organization field resource]() accepts.
`Organization Paid Accounts`	Whether or not to include paid account information in the returned workspace objects
`Organization Memberships`	Comma-seperated list of: me, normal, admin, active, deactivated
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get an Organization

/organizations/{id}

Retrieve details of a specific Trello organization (team).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the Organization
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Channel`	Channel to block notifications on
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get boardStars on a Board

/boards/{boardId}/boardStars

Retrieve all board stars for a specific board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Boardid`	The ID of the board whose actions to retrieve.
`Filter`	Valid values: mine, none
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get checkItem on a Card

/cards/{id}/checkItem/{idCheckItem}

Get a specific checkItem on a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idcheckitem`	The ID of the checkitem
`Fields`	all or a comma-separated list of name,nameData,pos,state,type,due,dueReminder,idMember
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get checkItems on a Card

/cards/{id}/checkItemStates

Get the completed checklist items on a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Fields`	all or a comma-separated list of: idCheckItem, state
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get custom Board Background of Member

/members/{id}/customBoardBackgrounds/{idBackground}

Get a specific custom board background

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idbackground`	The ID of the custom background
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get field on Organization

/organizations/{id}/{field}

Retrieve a specific field value from an organization, such as displayName or desc.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Field`	An organization field
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get field on a Checklist

/checklists/{id}/{field}

Retrieve a specific field value from a checklist, such as name or idBoard.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Field`	Field to update.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Board
`Filter`	Valid Values: all, closed, none, open, visible.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get filtered Lists on a Board

/boards/{id}/lists/{filter}

Retrieve lists on a board filtered by a specific criteria, such as open or closed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Filter`	One of all, closed, none, open
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get pluginData on a Card

/cards/{id}/pluginData

Get any shared pluginData on a card.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get signupUrl for Enterprise

/enterprises/{id}/signupUrl

Get the signup URL for an enterprise.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Authenticate`	Indicates whether to require the user to be authenticated before accessing the signup URL; set to true to require authentication.
`Confirmationaccepted`	Indicates whether the signup URL should only be provided after the user has accepted a confirmation; set to true to require confirmation.
`Returnurl`	Any valid URL.
`Tosaccepted`	Designates whether the user has seen/consented to the Trello ToS prior to being redirected to the enterprise signup page/their IdP.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Board a List is on

/lists/{id}/board

Get the board a list is on

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the list
`Fields`	all or a comma-separated list of board fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Board a Notification is on

/notifications/{id}/board

Get the board a notification is associated with

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification
`Fields`	all or a comma-separated list of boardfields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Board for an Action

/actions/{id}/board

Get the Board for an Action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the action
`Fields`	all or a comma-separated list of board fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Board the Card is on

/cards/{id}/board

Get the board a card is on

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Fields`	all or a comma-separated list of board fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Board the Checklist is on

/checklists/{id}/board

Retrieve the board that a specific checklist belongs to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Fields`	all or a comma-separated list of board fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Card a Checklist is on

/checklists/{id}/cards

Retrieve the card that a specific checklist is attached to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Card a Notification is on

/notifications/{id}/card

Get the card a notification is associated with

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification
`Fields`	all or a comma-separated list of card fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Card for an Action

/actions/{id}/card

Get the card for an action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the action
`Fields`	all or a comma-separated list of card fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the List a Notification is on

/notifications/{id}/list

Get the list a notification is associated with

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification
`Fields`	all or a comma-separated list of list fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the List for an Action

/actions/{id}/list

Get the List for an Action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the action
`Fields`	all or a comma-separated list of list fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the List of a Card

/cards/{id}/list

Get the list a card is in

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Fields`	all or a comma-separated list of list fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Member Creator of an Action

/actions/{id}/memberCreator

Get the Member who created the Action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Action
`Fields`	all or a comma-separated list of member fields
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification
`Fields`	all or a comma-separated list of member fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Member of an Action

/actions/{id}/member

Gets the member of an action (not the creator)

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Action
`Fields`	all or a comma-separated list of member fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Member who created the Notification

/notifications/{id}/memberCreator

Get the member who created the notification

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification
`Fields`	all or a comma-separated list of member fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Members of a Board

/boards/{id}/members

Get the Members for a board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Members of a Card

/cards/{id}/members

Get the members on a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Fields`	all or a comma-separated list of member fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Members of an Organization

/organizations/{id}/members

List the members in a Workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the Organization
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the Organization of an Action

/actions/{id}/organization

Get the Organization of an Action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the action
`Fields`	all or a comma-separated list of organization fields
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the pluginData Scoped to Organization

/organizations/{id}/pluginData

Get organization scoped pluginData on this Workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Enterprise to retrieve.
`Idorganization`	An ID of an Organization resource.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Invite Member to Board via email

/boards/{id}/members

Invite a Member to a Board via their email address.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board
`Email`	The email address of a user to add as a member of the board.
`Type`	Valid values: admin, normal, observer. Determines what type of member the user being added should be of the board.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Fullname`	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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idaction`	The ID of the action
`Response Type`	The response format expected from the API (e.g. application/json).

GET List available Emoji

/emoji

List available Emoji

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Locale`	The locale to return emoji descriptions and names in. Defaults to the logged in member's locale.
`Spritesheets`	true to return spritesheet URLs in the response
`Response Type`	The response format expected from the API (e.g. application/json).

POST Mark Board as viewed

/boards/{id}/markedAsViewed

Mark a specific board as viewed by the current member.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Response Type`	The response format expected from the API (e.g. application/json).

POST Mark a Card's Notifications as read

/cards/{id}/markAssociatedNotificationsRead

Mark notifications about this card as read

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Response Type`	The response format expected from the API (e.g. application/json).

POST Mark all Notifications as read

/notifications/all/read

Mark all notifications as read

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Read`	Boolean to specify whether to mark as read or unread (defaults to true, marking as read)
`Ids`	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.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Move List to Board

/lists/{id}/idBoard

Move a List to a different Board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the list
`Value`	The ID of the board to move the list to
`Response Type`	The response format expected from the API (e.g. application/json).

POST Move all Cards in List

/lists/{id}/moveAllCards

Move all Cards in a List

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the list
`Idboard`	The ID of the board the cards should be moved to
`Idlist`	The ID of the list that the cards should be moved to
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove Member from Board

/boards/{id}/members/{idMember}

Remove a specific member from a board.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Idmember`	The id of the member to add to the board.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove a Label from a Card

/cards/{id}/idLabels/{idLabel}

Remove a label from a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idlabel`	The ID of the label to remove
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Enterprise to retrieve.
`Idmember`	ID of the member to be removed as an admin from enterprise.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove a Member from a Card

/cards/{id}/idMembers/{idMember}

Remove a member from a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idmember`	The ID of the member to remove from the card
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove a Member from an Organization

/organizations/{id}/members/{idMember}

Remove a member from a Workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Idmember`	The ID of the Member to remove from the Workspace
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Idmember`	The ID of the member to remove from the Workspace
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idmember`	The ID of the member whose vote to remove
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Response Type`	The response format expected from the API (e.g. application/json).

GET Retrieve Organization's Exports

/organizations/{id}/exports

Retrieve the exports that exist for the given organization

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the Workspace
`Response Type`	The response format expected from the API (e.g. application/json).

GET Search Trello

/search

Find what you're looking for in Trello

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	The search query with a length of 1 to 16384 characters
`Idboards`	mine or a comma-separated list of Board IDs
`Idorganizations`	A comma-separated list of Organization IDs
`Idcards`	A comma-separated list of Card IDs
`Modeltypes`	What type or types of Trello objects you want to search. all or a comma-separated list of: actions, boards, cards, members, organizations
`Board Fields`	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
`Boards Limit`	The maximum number of boards returned. Maximum: 1000
`Board Organization`	Whether to include the parent organization with board results
`Card Fields`	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
`Cards Limit`	The maximum number of cards to return. Maximum: 1000
`Cards Page`	The page of results for cards. Maximum: 100
`Card Board`	Whether to include the parent board with card results
`Card List`	Whether to include the parent list with card results
`Card Members`	Whether to include member objects with card results
`Card Stickers`	Whether to include sticker objects with card results
`Card Attachments`	Whether to include attachment objects with card results. A boolean value (true or false) or cover for only card cover attachments.
`Organization Fields`	all or a comma-separated list of billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url, website
`Organizations Limit`	The maximum number of Workspaces to return. Maximum 1000
`Member Fields`	all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username
`Members Limit`	The maximum number of members to return. Maximum 1000
`Partial`	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".
`Response Type`	The response format expected from the API (e.g. application/json).

GET Search for Members

/search/members/

Search for Trello members.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	Search query 1 to 16384 characters long
`Limit`	The maximum number of results to return. Maximum of 20.
`Idboard`	The ID of a board to filter members by membership in that board.
`Idorganization`	The ID of an organization to filter members by membership in that organization.
`Onlyorgmembers`	Indicates whether to return only members who are part of the specified organization; set to true to restrict results.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Enterprise to retrieve.
`Idorganization`	ID of Organization to be transferred to Enterprise.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idcard`	The ID of the Card
`Idcheckitem`	The ID of the checklist item to update
`Pos`	top, bottom, or a positive float
`Idchecklist`	The ID of the item to update.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update Comment Action on a Card

/cards/{id}/actions/{idAction}/comments

Update an existing comment

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idaction`	The ID of the comment action to update
`Text`	The new text for the comment
`Response Type`	The response format expected from the API (e.g. application/json).

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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idcard`	ID of the card that the Custom Field value should be set/updated for
`Idcustomfield`	ID of the Custom Field on the card.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	The new value for the custom field item, provided as a JSON string representing the field's options.

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the enterprise to retrieve.
`Idmember`	ID of member to be made an admin of enterprise.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update Membership of Member on a Board

/boards/{id}/memberships/{idMembership}

Update an existing board by id

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Idmembership`	The id of a membership that should be added to this board.
`Type`	One of: admin, normal, observer. Determines the type of member that this membership will be to this board.
`Member Fields`	Valid values: all, avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username
`Response Type`	The response format expected from the API (e.g. application/json).

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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update Notification's read status

/notifications/{id}/unread

Update Notification's read status

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification
`Value`	The desired read status; set to true to mark as unread, or false to mark as read.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Board

/boards/{id}

Update an existing board by id

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the board to retrieve.
`Name`	The new name for the board. 1 to 16384 characters long.
`Desc`	A new description for the board, 0 to 16384 characters long
`Closed`	Whether the board is closed
`Subscribed`	Whether the acting user is subscribed to the board
`Idorganization`	The id of the Workspace the board should be moved to
`Prefs/permissionlevel`	One of: org, private, public
`Prefs/selfjoin`	Whether Workspace members can join the board themselves
`Prefs/cardcovers`	Whether card covers should be displayed on this board
`Prefs/hidevotes`	Determines whether the Voting Power-Up should hide who voted on cards or not.
`Prefs/invitations`	Who can invite people to this board. One of: admins, members
`Prefs/voting`	Who can vote on this board. One of disabled, members, observers, org, public
`Prefs/comments`	Who can comment on cards on this board. One of: disabled, members, observers, org, public
`Prefs/background`	The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey
`Prefs/cardaging`	One of: pirate, regular
`Prefs/calendarfeedenabled`	Determines whether the calendar feed is enabled or not.
`Labelnames/green`	Name for the green label. 1 to 16384 characters long
`Labelnames/yellow`	Name for the yellow label. 1 to 16384 characters long
`Labelnames/orange`	Name for the orange label. 1 to 16384 characters long
`Labelnames/red`	Name for the red label. 1 to 16384 characters long
`Labelnames/purple`	Name for the purple label. 1 to 16384 characters long
`Labelnames/blue`	Name for the blue label. 1 to 16384 characters long
`Response Type`	The response format expected from the API (e.g. application/json).

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

headers

Additional HTTP header name/value pairs to include in the request.

Id

The ID of the Card

Name

The new name for the card

Desc

The new description for the card

Closed

Whether the card should be archived (closed: true)

Idmembers

Comma-separated list of member IDs

Idattachmentcover

The ID of the image attachment the card should use as its cover, or null for none

Idlist

The ID of the list the card should be in

Idlabels

Comma-separated list of label IDs

Idboard

The ID of the board the card should be on

Pos

The position of the card in its list. top, bottom, or a positive float

Due

When the card is due, or null

Start

The start date of a card, or null

Duecomplete

Whether the due date should be marked complete

Subscribed

Whether the member is should be subscribed to the card

Address

For use with/by the Map View

Locationname

For use with/by the Map View

Coordinates

For use with/by the Map View. Should be latitude,longitude

Cover

Updates the card's cover

Option	Values	About
color	pink, yellow, lime, blue, black, orange, red, purple, sky, green	Makes the cover a solid color .
brightness	dark, light	Determines whether the text on the cover should be dark or light.
url	An unsplash URL: https://images.unsplash.com	Used if making an image the cover. Only Unsplash URLs work.
idAttachment	ID of an attachment on the card	Used if setting an attached image as the cover.
size	normal, full	Determines whether to show the card name on the cover, or below it.

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:
![](/cloud/trello/images/rest/cards/cover-brightness-dark.png)

And vice versa, setting it to dark will make the text on the card cover light:
![](/cloud/trello/images/rest/cards/cover-brightness-light.png)

Response Type

The response format expected from the API (e.g. application/json).

PUT Update a Checklist

/checklists/{id}

Update an existing checklist.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Name`	Name of the new checklist being created. Should be length of 1 to 16384.
`Pos`	Determines the position of the checklist on the card. One of: top, bottom, or a positive number.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Comment Action

/actions/{id}/text

Update a comment action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the action to update
`Value`	The new text for the comment
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Custom Field definition

/customFields/{id}

Update a Custom Field definition.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Custom Field.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The name of the Custom Field
`Display/cardfront`	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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Label
`Name`	The new name for the label
`Color`	The new color for the label. See: fields for color options
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a List

/lists/{id}

Update the properties of a List

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the list
`Name`	New name for the list
`Closed`	Whether the list should be closed (archived)
`Idboard`	ID of a board the list should be moved to
`Pos`	New position for the list: top, bottom, or a positive floating point number
`Subscribed`	Whether the active member is subscribed to this list
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Member

/members/{id}

Update a Member

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Fullname`	New name for the member. Cannot begin or end with a space.
`Initials`	New initials for the member. 1-4 characters long.
`Username`	New username for the member. At least 3 characters long, only lowercase letters, underscores, and numbers. Must be unique.
`Bio`	The new biography text for the member's profile.
`Avatarsource`	One of: gravatar, none, upload
`Prefs/colorblind`	Indicates whether to enable colorblind-friendly mode; set to true to enable.
`Prefs/locale`	The locale preference for the member, such as en-US or de.
`Prefs/minutesbetweensummaries`	-1 for disabled, 1, or 60
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Idmember`	The ID or username of the member to update
`Type`	One of: admin, normal
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Member's custom Board background

/members/{id}/boardBackgrounds/{idBackground}

Update a board background

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idbackground`	The ID of the board background
`Brightness`	One of: dark, light, unknown
`Tile`	Whether the background should be tiled
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the Enterprise.
`Idmember`	The ID of the Member
`Value`	Boolean value to determine whether the user should be given an Enterprise license (true) or not (false).
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Notification's read status

/notifications/{id}

Update the read status of a notification

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the notification
`Unread`	Whether the notification should be marked as read or not
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Plugin

/plugins/{id}/

Update a Plugin

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Sticker on a Card

/cards/{id}/stickers/{idSticker}

Update a sticker on a card

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idsticker`	The ID of the sticker
`Top`	The top position of the sticker, from -60 to 100
`Left`	The left position of the sticker, from -60 to 100
`Zindex`	The z-index of the sticker
`Rotate`	The rotation of the sticker
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Webhook

/webhooks/{id}

Update a webhook by ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of the webhook to retrieve.
`Description`	A string with a length from 0 to 16384.
`Callbackurl`	A valid URL that is reachable with a HEAD and POST request.
`Idmodel`	ID of the model to be monitored
`Active`	Determines whether the webhook is active and sending POST requests.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Webhook created by Token

/tokens/{token}/webhooks/{idWebhook}

Update a Webhook created by Token

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	The token whose webhooks to fetch.
`Idwebhook`	ID of the Webhooks to retrieve.
`Description`	A description to be displayed when retrieving information about the webhook.
`Callbackurl`	The URL that the webhook should POST information to.
`Idmodel`	ID of the object that the webhook is on.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a checkItem on a Card

/cards/{id}/checkItem/{idCheckItem}

Update an item in a checklist on a card.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Card
`Idcheckitem`	The ID of the checkitem
`Name`	The new name for the checklist item
`State`	One of: complete, incomplete
`Idchecklist`	The ID of the checklist this item is in
`Pos`	top, bottom, or a positive float
`Due`	A due date for the checkitem
`Duereminder`	A dueReminder for the due date on the checkitem
`Idmember`	The ID of the member to remove from the card
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a field on a List

/lists/{id}/{field}

Rename a list

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the list
`Field`	The field on the List to be updated
`Value`	The new value for the field
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a field on a label

/labels/{id}/{field}

Update a field on a label.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the label
`Field`	The field on the Label to update.
`Value`	The new value for the field.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a saved search

/members/{id}/savedSearches/{idSearch}

Update a saved search

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idsearch`	The ID of the saved search to delete
`Name`	The new name for the saved search
`Query`	The new search query
`Pos`	New position for saves search. top, bottom, or a positive float.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID of the Action
`Text`	The new text for the comment
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update an Organization

/organizations/{id}

Update an organization

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the Organization
`Name`	A new name for the organization. At least 3 lowercase letters, underscores, and numbers. Must be unique
`Displayname`	A new displayName for the organization. Must be at least 1 character long and not begin or end with a space.
`Desc`	A new description for the organization
`Website`	A URL starting with http://, https://, or null
`Prefs/associateddomain`	The Google Apps domain to link this org to.
`Prefs/externalmembersdisabled`	Whether non-workspace members can be added to boards inside the Workspace
`Prefs/googleappsversion`	1 or 2
`Prefs/boardvisibilityrestrict/org`	Who on the Workspace can make Workspace visible boards. One of admin, none, org
`Prefs/boardvisibilityrestrict/private`	Who can make private boards. One of: admin, none, org
`Prefs/boardvisibilityrestrict/public`	Who on the Workspace can make public boards. One of: admin, none, org
`Prefs/orginviterestrict`	An email address with optional wildcard characters. (E.g. subdomain.*.trello.com)
`Prefs/permissionlevel`	Whether the Workspace page is publicly visible. One of: private, public
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update an Organization's Members

/organizations/{id}/members

Update the members list of a specific organization (team).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the organization
`Email`	An email address
`Fullname`	Name for the member, at least 1 character not beginning or ending with a space
`Type`	One of: admin, normal
`Response Type`	The response format expected from the API (e.g. application/json).

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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Channel`	The notification channel (e.g., email or web) for which to update blocked notification keys.

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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Channel`	Channel to block notifications on
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Channel`	Channel to block notifications on
`Blockedkeys`	Singular key or comma-separated list of notification keys
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update custom Board Background of Member

/members/{id}/customBoardBackgrounds/{idBackground}

Update a specific custom board background

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idbackground`	The ID of the custom background
`Brightness`	One of: dark, light, unknown
`Tile`	Whether to tile the background
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update emailPosition Pref on a Board

/boards/{id}/myPrefs/emailPosition

Update emailPosition Pref on a Board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Value`	Valid values: bottom, top. Determines the position of the email address.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update field on a Checklist

/checklists/{id}/{field}

Update a specific field on a checklist, such as its name or position.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	ID of a checklist.
`Field`	Field to update.
`Value`	The value to change the checklist name to. Should be a string of length 1 to 16384.
`Response Type`	The response format expected from the API (e.g. application/json).

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Value`	The id of an email list.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Update logo for an Organization

/organizations/{id}/logo

Set the logo image for a Workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or name of the Workspace
`File`	Image file for the logo
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update showListGuide Pref on a Board

/boards/{id}/myPrefs/showListGuide

Update the 'showListGuide' preference for your user on a specific board. This controls whether the list guide is displayed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Value`	Determines whether to show the list guide.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update showSidebar Pref on a Board

/boards/{id}/myPrefs/showSidebar

Update the 'showSidebar' preference for your user on a specific board. This controls whether the sidebar is shown.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Value`	Determines whether to show the side bar.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update showSidebarActivity Pref on a Board

/boards/{id}/myPrefs/showSidebarActivity

Update the 'showSidebarActivity' preference for your user on a specific board. This controls whether activity is shown in the sidebar.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Value`	Determines whether to show sidebar activity.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update showSidebarBoardActions Pref on a Board

/boards/{id}/myPrefs/showSidebarBoardActions

Update the 'showSidebarBoardActions' preference for your user on a specific board. This controls whether board actions are shown in the sidebar.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Value`	Determines whether to show the sidebar board actions.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update showSidebarMembers Pref on a Board

/boards/{id}/myPrefs/showSidebarMembers

Update the 'showSidebarMembers' preference for your user on a specific board. This controls whether members are shown in the sidebar.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the board to update
`Value`	Determines whether to show members of the board in the sidebar.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update the position of a boardStar of Member

/members/{id}/boardStars/{idStar}

Update the position of a starred board

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`Idstar`	The ID of the board star
`Pos`	New position for the starred board. top, bottom, or a positive float.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Updating Plugin's Listing

/plugins/{idPlugin}/listings/{idListing}

Update an existing listing for your Power-Up

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idplugin`	The ID of the Power-Up whose listing is being updated.
`Idlisting`	The ID of the existing listing for the Power-Up that is being updated.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Description`	The description to show for the given locale
`Locale`	The locale that this listing should be displayed for.
`Overview`	The overview to show for the given locale.
`Name`	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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`File`	The file data of the sticker image to upload.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Upload new boardBackground for Member

/members/{id}/boardBackgrounds

Upload a new boardBackground

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The ID or username of the member
`File`	The file data of the sticker image to upload.
`Response Type`	The response format expected from the API (e.g. application/json).