Rate this page:

Actions

Get an Action

GET /1/actions/{id}

Get an Action

Request

Path parameters
id Required

string

The ID of the Action

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
display

boolean

Default: true
entities

boolean

Default: false
fields

string

all or a comma-separated list of action fields

Default: all
member

boolean

Default: true
member_fields

string

all or a comma-separated list of member fields

Default: avatarHash,fullName,initials,username
memberCreator

boolean

Whether to include the member object for the creator of the action

Default: true
memberCreator_fields

string

all or a comma-separated list of member fields

Default: avatarHash,fullName,initials,username

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}'

Responses

Success

A schema has not been defined for this response code.

Update an Action

PUT /1/actions/{id}

Update a specific Action. Only comment actions can be updated. Used to edit the content of a comment.

Request

Path parameters
id Required

string

The ID of the Action

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
text Required

string

The new text for the comment

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/actions/{id}?text={text}'

Responses

Success

A schema has not been defined for this response code.

Delete an Action

DELETE /1/actions/{id}

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

Request

Path parameters
id Required

string

The ID of the Action

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/actions/{id}'

Responses

Success

A schema has not been defined for this response code.

Get a specific field on an Action

GET /1/actions/{id}/{field}

Get a specific property of an action

Request

Path parameters
id Required

string

The ID of the Action

Pattern: ^[0-9a-fA-F]{24}$
field Required

string

An action field

Valid values: id, idMemberCreator, data, type, date, limits, display, memberCreator

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/{field}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Action

Get the Board for an Action

GET /1/actions/{id}/board

Get the Board for an Action

Request

Path parameters
id Required

string

The ID of the action

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of board fields

Valid values: id, name, desc, descData, closed, idOrganization, pinned, url, shortUrl, prefs ...(Show more)

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/board' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Board

Get the Card for an Action

GET /1/actions/{id}/card

Get the card for an action

Request

Path parameters
id Required

string

The ID of the action

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of card fields

Valid values: id, address, badges, checkItemStates, closed, coordinates, creationMethod, dueComplete, dateLastActivity, desc ...(Show more)

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/card' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Card

Get the List for an Action

GET /1/actions/{id}/list

Get the List for an Action

Request

Path parameters
id Required

string

The ID of the action

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of list fields

Valid values: id

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/list' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

List

Get the Member of an Action

GET /1/actions/{id}/member

Gets the member of an action (not the creator)

Request

Path parameters
id Required

string

The ID of the Action

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of member fields

Valid values: id

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/member' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Member

Get the Member Creator of an Action

GET /1/actions/{id}/memberCreator

Get the Member who created the Action

Request

Path parameters
id Required

string

The ID of the Action

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of member fields

Valid values: id

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/memberCreator' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Member

Get the Organization of an Action

GET /1/actions/{id}/organization

Get the Organization of an Action

Request

Path parameters
id Required

string

The ID of the action

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of organization fields

Valid values: id, name

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/actions/{id}/organization' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Organization

Update a Comment Action

PUT /1/actions/{id}/text

Update a comment action

Request

Path parameters
id Required

string

The ID of the action to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

string

The new text for the comment

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/actions/{id}/text?value={value}'

Responses

Success

A schema has not been defined for this response code.

Get Action's Reactions

GET /1/actions/{idAction}/reactions

List reactions for an action

Request

Path parameters
idAction Required

string

The ID of the action

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
member

boolean

Whether to load the member as a nested resource. See Members Nested Resource

Default: true
emoji

boolean

Whether to load the emoji as a nested resource.

Default: true

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/actions/{idAction}/reactions'

Responses

Success

A schema has not been defined for this response code.

Create Reaction for Action

POST /1/actions/{idAction}/reactions

Adds a new reaction to an action

Request

Path parameters
idAction Required

string

The ID of the action

Pattern: ^[0-9a-fA-F]{24}$
Body parameters
shortName

string

The primary shortName of the emoji to add. See /emoji

skinVariation

string

The skinVariation of the emoji to add. See /emoji

native

string

The emoji to add as a native unicode emoji. See /emoji

unified

string

The unified value of the emoji to add. See /emoji

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/actions/{idAction}/reactions'

Responses

Success

A schema has not been defined for this response code.

Get Action's Reaction

GET /1/actions/{idAction}/reactions/{id}

Get information for a reaction

Request

Path parameters
idAction Required

string

The ID of the Action

Pattern: ^[0-9a-fA-F]{24}$
id Required

string

The ID of the reaction

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
member

boolean

Whether to load the member as a nested resource. See Members Nested Resource

Default: true
emoji

boolean

Whether to load the emoji as a nested resource.

Default: true

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/actions/{idAction}/reactions/{id}'

Responses

Success

A schema has not been defined for this response code.

Delete Action's Reaction

DELETE /1/actions/{idAction}/reactions/{id}

Deletes a reaction

Request

Path parameters
idAction Required

string

The ID of the Action

Pattern: ^[0-9a-fA-F]{24}$
id Required

string

The ID of the reaction

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/actions/{idAction}/reactions/{id}'

Responses

Success

A schema has not been defined for this response code.

List Action's summary of Reactions

GET /1/actions/{idAction}/reactionsSummary

List a summary of all reactions for an action

Request

Path parameters
idAction Required

string

The ID of the action

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/actions/{idAction}/reactionsSummary'

Responses

Success

A schema has not been defined for this response code.

Applications

Get Appication's compliance data

GET /1/applications/{key}/compliance

Request

Path parameters
key Required

string

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/applications/{key}/compliance'

Responses

Success

A schema has not been defined for this response code.

Batch

Batch Requests

GET /1/batch

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

Request

Query parameters
urls Required

string

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"

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/batch?urls={urls}'

Responses

Success

A schema has not been defined for this response code.

Boards

Get Memberships of a Board

GET /1/boards/{id}/memberships

Get information about the memberships users have to the board.

Request

Path parameters
id Required

string

The ID of the board

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
filter

string

One of admins, all, none, normal

Default: all

Valid values: admins, all, none, normal

activity

boolean

Works for premium organizations only.

Default: false
orgMemberType

boolean

Shows the type of member to the org the user is. For instance, an org admin will have a orgMemberType of admin.

Default: false
member

boolean

Determines whether to include a nested member object.

Default: false
member_fields

string

Fields to show if member=true. Valid values: nested member resource fields.

Style: form

Valid values: id

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/memberships' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Memberships

Get a Board

GET /1/boards/{id}

Request a single board.

Request

Path parameters
id Required

string

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
actions

string

This is a nested resource. Read more about actions as nested resources here.

Default: all
boardStars

string

Valid values are one of: mine or none.

Default: none
cards

string

This is a nested resource. Read more about cards as nested resources here.

Default: none
card_pluginData

boolean

Use with the cards param to include card pluginData with the response

Default: false
checklists

string

This is a nested resource. Read more about checklists as nested resources here.

Default: none
customFields

boolean

This is a nested resource. Read more about custom fields as nested resources here.

Default: false
fields

string

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, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url

Default: name,desc,descData,closed,idOrganization,pinned,url,shortUrl,prefs,labelNames
labels

string

This is a nested resource. Read more about labels as nested resources here.

lists

string

This is a nested resource. Read more about lists as nested resources here.

Default: open
members

string

This is a nested resource. Read more about members as nested resources here.

Default: none
memberships

string

This is a nested resource. Read more about memberships as nested resources here.

Default: none
membersInvited

string

Returns a list of member objects representing members who been invited to be a member of the board. One of: admins, all, none, normal, owners

Default: none
membersInvited_fields

string

The member fields to be included in the membersInvited response. Valid values: all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username

Default: all
pluginData

boolean

Determines whether the pluginData for this board should be returned. Valid values: true or false.

Default: false
organization

boolean

This is a nested resource. Read more about organizations as nested resources here.

Default: false
organization_pluginData

boolean

Use with the organization param to include organization pluginData with the response

Default: false
myPrefs

boolean

Default: false
tags

boolean

Also known as collections, tags, refer to the collection(s) that a Board belongs to.

Default: false

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Board

Update a Board

PUT /1/boards/{id}

Update an existing board by id

Request

Path parameters
id Required

string

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
name

string

The new name for the board. 1 to 16384 characters long.

desc

string

A new description for the board, 0 to 16384 characters long

closed

boolean

Whether the board is closed

subscribed

string

Whether the acting user is subscribed to the board

Style: form, Pattern: ^[0-9a-fA-F]{24}$
idOrganization

string

The id of the team the board should be moved to

prefs/permissionLevel

string

One of: org, private, public

prefs/selfJoin

boolean

Whether team members can join the board themselves

prefs/cardCovers

boolean

Whether card covers should be displayed on this board

prefs/hideVotes

boolean

Determines whether the Voting Power-Up should hide who voted on cards or not.

prefs/invitations

string

Who can invite people to this board. One of: admins, members

prefs/voting

string

Who can vote on this board. One of disabled, members, observers, org, public

prefs/comments

string

Who can comment on cards on this board. One of: disabled, members, observers, org, public

prefs/background

string

The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey

prefs/cardAging

string

One of: pirate, regular

prefs/calendarFeedEnabled

boolean

Determines whether the calendar feed is enabled or not.

labelNames/green

string

Name for the green label. 1 to 16384 characters long

labelNames/yellow

string

Name for the yellow label. 1 to 16384 characters long

labelNames/orange

string

Name for the orange label. 1 to 16384 characters long

labelNames/red

string

Name for the red label. 1 to 16384 characters long

labelNames/purple

string

Name for the purple label. 1 to 16384 characters long

labelNames/blue

string

Name for the blue label. 1 to 16384 characters long

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}'

Responses

Success

A schema has not been defined for this response code.

Delete a Board

DELETE /1/boards/{id}

Delete a board.

Request

Path parameters
id Required

string

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/boards/{id}'

Responses

Success

A schema has not been defined for this response code.

Get a field on a Board

GET /1/boards/{id}/{field}

Get a single, specific field on a board

Request

Path parameters
id Required

string

The ID of the board.

field Required

string

The field you'd like to receive. Valid values: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url.

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/{field}'

Responses

Success

A schema has not been defined for this response code.

Get Actions of a Board

GET /1/boards/{boardId}/actions

Request

Path parameters
boardId Required

string

Query parameters
filter

string

A comma-separated list of action types.

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/boards/{boardId}/actions'

Responses

Success

A schema has not been defined for this response code.

Get a Card on a Board

GET /1/boards/{id}/cards/{idCard}

Get a single Card on a Board.

Request

Path parameters
id Required

string

The ID of the board

idCard Required

string

The id the card to retrieve.

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/cards/{idCard}'

Responses

Success

A schema has not been defined for this response code.

Get boardStars on a Board

GET /1/boards/{boardId}/boardStars

Request

Path parameters
boardId Required

string

filter Required

string

Valid values: mine, none

Default: mine

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/boards/{boardId}/boardStars' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<BoardStars>

Get Checklists on a Board

GET /1/boards/{id}/checklists

Get all of the checklists on a Board.

Request

Path parameters
id Required

string

The ID of the board

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/checklists'

Responses

Success

A schema has not been defined for this response code.

Create Checklist on a Board

POST /1/boards/{id}/checklists

Create a new checklist on a board.

Request

Path parameters
id Required

string

The id of the board to update

Query parameters
name Required

string

The name of the checklist to be created. 1 to 16384 characters long.

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/checklists?name={name}'

Responses

Success

A schema has not been defined for this response code.

Get Cards on a Board

GET /1/boards/{id}/cards

Get all of the open Cards on a Board.

Request

Path parameters
id Required

string

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/cards'

Responses

Success

A schema has not been defined for this response code.

Get filtered Cards on a Board

GET /1/boards/{id}/cards/{filter}

Get the Cards on a Board that match a given filter.

Request

Path parameters
id Required

string

ID of the Board

filter Required

string

Valid Values: all, closed, none, open, visible.

Valid values: all, closed, none, open, visible

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/cards/{filter}'

Responses

Success

A schema has not been defined for this response code.

Get Custom Fields for Board

GET /1/boards/{id}/customFields

Get the Custom Field Definitions that exist on a board.

Request

Path parameters
id Required

string

The ID of the board

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/customFields' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<CustomField>

Get Labels on a Board

GET /1/boards/{id}/labels

Get all of the Labels on a Board.

Request

Path parameters
id Required

string

The ID of the Board.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

Label

The fields to be returned for the Labels.

limit

integer

The number of Labels to be returned.

Default: 50, Minimum: 0, Maximum: 1000, Format: int32

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/labels'

Responses

Success

A schema has not been defined for this response code.

Create a Label on a Board

POST /1/boards/{id}/labels

Create a new Label on a Board.

Request

Path parameters
id Required

string

The id of the board to update

Query parameters
name Required

string

The name of the label to be created. 1 to 16384 characters long.

color Required

string

Sets the color of the new label. Valid values are a label color or null.

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/labels?name={name}&color={color}'

Responses

Success

A schema has not been defined for this response code.

Get Lists on a Board

GET /1/boards/{id}/lists

Get the Lists on a Board

Request

Path parameters
id Required

string

The ID of the board

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
cards

string

Filter to apply to Cards.

Valid values: all, closed, none, open

card_fields

string

all or a comma-separated list of card fields

Default: all
filter

string

Filter to apply to Lists

Valid values: all, closed, none, open

fields

string

all or a comma-separated list of list fields

Default: all

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/lists'

Responses

Success

A schema has not been defined for this response code.

Create a List on a Board

POST /1/boards/{id}/lists

Create a new List on a Board.

Request

Path parameters
id Required

string

The ID of the board

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
name Required

string

The name of the list to be created. 1 to 16384 characters long.

pos

string

Determines the position of the list. Valid values: top, bottom, or a positive number.

Default: top

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/lists?name={name}'

Responses

Success

A schema has not been defined for this response code.

Get filtered Lists on a Board

GET /1/boards/{id}/lists/{filter}

Request

Path parameters
id Required

string

The ID of the board

Pattern: ^[0-9a-fA-F]{24}$
filter Required

string

One of all, closed, none, open

Valid values: all, closed, none, open

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/lists/{filter}'

Responses

Success

A schema has not been defined for this response code.

Get the Members of a Board

GET /1/boards/{id}/members

Get the Members for a board

Request

Path parameters
id Required

string

The ID of the board

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/members'

Responses

Success

A schema has not been defined for this response code.

Invite Member to Board via email

PUT /1/boards/{id}/members

Invite a Member to a Board via their email address.

Request

Path parameters
id Required

string

The ID of the board

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
email Required

string

The email address of a user to add as a member of the board.

Format: email
type

string

Valid values: admin, normal, observer. Determines what type of member the user being added should be of the board.

Default: normal

Valid values: admin, normal, observer

Body parameters
fullName

string

The full name of the user to as a member of the board. Must have a length of at least 1 and cannot begin nor end with a space.

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/members?email={email}'

Responses

Success

A schema has not been defined for this response code.

Add a Member to a Board

PUT /1/boards/{id}/members/{idMember}

Add a member to the board.

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
idMember Required

string

The id of the member to add to the board.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
type Required

string

One of: admin, normal, observer. Determines the type of member this user will be on the board.

Valid values: admin, normal, observer

allowBillableGuest

boolean

Optional param that allows organization admins to add multi-board guests onto a board.

Default: false

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/members/{idMember}?type={type}'

Responses

Success

A schema has not been defined for this response code.

Remove Member from Board

DELETE /1/boards/{id}/members/{idMember}

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
idMember Required

string

The id of the member to add to the board.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/boards/{id}/members/{idMember}'

Responses

Success

A schema has not been defined for this response code.

Update Membership of Member on a Board

PUT /1/boards/{id}/memberships/{idMembership}

Update an existing board by id

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
idMembership Required

string

The id of a membership that should be added to this board.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
type Required

string

One of: admin, normal, observer. Determines the type of member that this membership will be to this board.

Valid values: admin, normal, observer

member_fields

string

Valid values: all, avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username

Style: form, Default: fullName, username

Valid values: all, avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products ...(Show more)

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/memberships/{idMembership}?type={type}'

Responses

Success

A schema has not been defined for this response code.

Update emailPosition Pref on a Board

PUT /1/boards/{id}/myPrefs/emailPosition

Update emailPosition Pref on a Board

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

string

Valid values: bottom, top. Determines the position of the email address.

Valid values: bottom, top

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/emailPosition?value={value}'

Responses

Success

A schema has not been defined for this response code.

Update idEmailList Pref on a Board

PUT /1/boards/{id}/myPrefs/idEmailList

Change the default list that email-to-board cards are created in.

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

string

The id of an email list.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/idEmailList?value=5abbe4b7ddc1b351ef961414'

Responses

Success

A schema has not been defined for this response code.

Update showListGuide Pref on a Board

PUT /1/boards/{id}/myPrefs/showListGuide

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

boolean

Determines whether to show the list guide.

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/showListGuide?value={value}'

Responses

Success

A schema has not been defined for this response code.

Update showSidebar Pref on a Board

PUT /1/boards/{id}/myPrefs/showSidebar

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

boolean

Determines whether to show the side bar.

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebar?value={value}'

Responses

Success

A schema has not been defined for this response code.

Update showSidebarActivity Pref on a Board

PUT /1/boards/{id}/myPrefs/showSidebarActivity

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

boolean

Determines whether to show sidebar activity.

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarActivity?value={value}'

Responses

Success

A schema has not been defined for this response code.

Update showSidebarBoardActions Pref on a Board

PUT /1/boards/{id}/myPrefs/showSidebarBoardActions

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

boolean

Determines whether to show the sidebar board actions.

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarBoardActions?value={value}'

Responses

Success

A schema has not been defined for this response code.

Update showSidebarMembers Pref on a Board

PUT /1/boards/{id}/myPrefs/showSidebarMembers

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

boolean

Determines whether to show members of the board in the sidebar.

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/boards/{id}/myPrefs/showSidebarMembers?value={value}'

Responses

Success

A schema has not been defined for this response code.

Create a Board

POST /1/boards/

Create a new board.

Request

Query parameters
name Required

string

The new name for the board. 1 to 16384 characters long.

Min length: 1, Max length: 16384
defaultLabels

boolean

Determines whether to use the default set of labels.

Default: true
defaultLists

boolean

Determines whether to add the default set of lists to a board (To Do, Doing, Done). It is ignored if idBoardSource is provided.

Default: true
desc

string

A new description for the board, 0 to 16384 characters long

Min length: 0, Max length: 16384
idOrganization

string

The id or name of the team the board should belong to.

Pattern: ^[0-9a-fA-F]{24}$
idBoardSource

string

The id of a board to copy into the new board.

Pattern: ^[0-9a-fA-F]{24}$
keepFromSource

string

To keep cards from the original board pass in the value cards

Default: none

Valid values: cards, none

powerUps

string

The Power-Ups that should be enabled on the new board. One of: all, calendar, cardAging, recap, voting.

Valid values: all, calendar, cardAging, recap, voting

prefs_permissionLevel

string

The permissions level of the board. One of: org, private, public.

Default: private

Valid values: org, private, public

prefs_voting

string

Who can vote on this board. One of disabled, members, observers, org, public.

Default: disabled

Valid values: disabled, members, observers, org, public

prefs_comments

string

Who can comment on cards on this board. One of: disabled, members, observers, org, public.

Default: members

Valid values: disabled, members, observers, org, public

prefs_invitations

string

Determines what types of members can invite users to join. One of: admins, members.

Default: members

Valid values: members, admins

prefs_selfJoin

boolean

Determines whether users can join the boards themselves or whether they have to be invited.

Default: true
prefs_cardCovers

boolean

Determines whether card covers are enabled.

Default: true
prefs_background

string

The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey.

Default: blue

Valid values: blue, orange, green, red, purple, pink, lime, sky, grey

prefs_cardAging

string

Determines the type of card aging that should take place on the board if card aging is enabled. One of: pirate, regular.

Default: regular

Valid values: pirate, regular

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/boards/?name={name}'

Responses

Success

A schema has not been defined for this response code.

Create a calendarKey for a Board

POST /1/boards/{id}/calendarKey/generate

Create a new board.

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/calendarKey/generate'

Responses

Success

A schema has not been defined for this response code.

Create a emailKey for a Board

POST /1/boards/{id}/emailKey/generate

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/emailKey/generate'

Responses

Success

A schema has not been defined for this response code.

Create a Tag for a Board

POST /1/boards/{id}/idTags

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

string

The id of a tag from the organization to which this board belongs.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/idTags?value=5abbe4b7ddc1b351ef961414'

Responses

Success

A schema has not been defined for this response code.

Mark Board as viewed

POST /1/boards/{id}/markedAsViewed

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/markedAsViewed'

Responses

Success

A schema has not been defined for this response code.

Enable Power-Up on a Board

POST /1/boards/{id}/powerUps

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

string

The Power-Up to be enabled on the board. One of: calendar, cardAging, recap, voting.

Valid values: calendar, cardAging, recap, voting

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/powerUps?value={value}'

Responses

Success

A schema has not been defined for this response code.

Disable Power-Up on a Board

DELETE /1/boards/{id}/powerUps/{powerUp}

Request

Path parameters
id Required

string

The id of the board to update

Pattern: ^[0-9a-fA-F]{24}$
powerUp Required

string

The Power-Up to be enabled on the board. One of: calendar, cardAging, recap, voting.

Valid values: calendar, cardAging, recap, voting

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/boards/{id}/powerUps/{powerUp}'

Responses

Success

A schema has not been defined for this response code.

Get Enabled Power-Ups on Board

GET /1/boards/{id}/boardPlugins

Get the enabled Power-Ups on a board

Request

Path parameters
id Required

string

The ID of the Board

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/boardPlugins' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<Plugin>

Enable a Power-Up on a Board

POST /1/boards/{id}/boardPlugins

Enable a Power-Up on a Board

Request

Path parameters
id Required

string

The ID of the Board

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
idPlugin

string

The ID of the Power-Up to enable

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/boards/{id}/boardPlugins'

Responses

Success

A schema has not been defined for this response code.

Disable a Power-Up on a Board

DELETE /1/boards/{id}/boardPlugins/{idPlugin}

Disable a Power-Up on a board

Request

Path parameters
id Required

string

The ID of the board

Pattern: ^[0-9a-fA-F]{24}$
idPlugin Required

string

The ID of the Power-Up to disable

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/boards/{id}/boardPlugins/{idPlugin}'

Responses

Success

A schema has not been defined for this response code.

Get Power-Ups on a Board

GET /1/boards/{id}/plugins

List the Power-Ups on a board

Request

Path parameters
id Required

string

The ID of the board

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
filter

string

One of: enabled or available

Default: enabled

Valid values: enabled, available

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/boards/{id}/plugins' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Plugin

Cards

Create a new Card

POST /1/cards

Create a new card

Request

Query parameters
name

string

The name for the card

desc

string

The description for the card

pos

oneOf [string, number]

The position of the new card. top, bottom, or a positive float

due

string

A due date for the card

Format: date
dueComplete

boolean

idList Required

string

The ID of the list the card should be created in

Pattern: ^[0-9a-fA-F]{24}$
idMembers

Array<string>

Comma-separated list of member IDs to add to the card

idLabels

Array<string>

Comma-separated list of label IDs to add to the card

urlSource

string

A URL starting with http:// or https://

Format: url
fileSource

string

Format: binary
idCardSource

string

The ID of a card to copy into the new card

Pattern: ^[0-9a-fA-F]{24}$
keepFromSource

string

If using idCardSource you can specify which properties to copy over. all or comma-separated list of: attachments,checklists,comments,due,labels,members,stickers

Style: form, Default: all

Valid values: all, attachments, checklists, comments, due, labels, members, stickers

address

string

For use with/by the Map Power-Up

locationName

string

For use with/by the Map Power-Up

coordinates

string

For use with/by the Map Power-Up. Should take the form latitude,longitude

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/cards?idList=5abbe4b7ddc1b351ef961414'

Responses

Success

A schema has not been defined for this response code.

Get a Card

GET /1/cards/{id}

Get a card by its ID

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of fields. Defaults: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idBoard, idChecklists, idLabels, idList, idMembers, idShort, idAttachmentCover, manualCoverAttachment, labels, name, pos, shortUrl, url

actions

string

attachments

oneOf [string, boolean]

true, false, or cover

Default: false
attachment_fields

string

all or a comma-separated list of attachment fields

Default: all
members

boolean

Whether to return member objects for members on the card

Default: false
member_fields

string

all or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username

membersVoted

boolean

Whether to return member objects for members who voted on the card

Default: false
memberVoted_fields

string

all or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username

checkItemStates

boolean

Default: false
checklists

string

Whether to return the checklists on the card. all or none

Default: none
checklist_fields

string

all or a comma-separated list of idBoard,idCard,name,pos

Default: all
board

boolean

Whether to return the board object the card is on

Default: false
board_fields

string

all or a comma-separated list of board fields. Defaults: name, desc, descData, closed, idOrganization, pinned, url, prefs

list

boolean

Default: false
pluginData

boolean

Whether to include pluginData on the card with the response

Default: false
stickers

boolean

Whether to include sticker models with the response

Default: false
sticker_fields

string

all or a comma-separated list of sticker fields

Default: all
customFieldItems

boolean

Whether to include the customFieldItems

Default: false

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Card

Update a Card

PUT /1/cards/{id}

Update a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
name

string

The new name for the card

desc

string

The new description for the card

closed

boolean

Whether the card should be archived (closed: true)

idMembers

string

Comma-separated list of member IDs

Style: form, Pattern: ^[0-9a-fA-F]{24}$
idAttachmentCover

string

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

Pattern: ^[0-9a-fA-F]{24}$
idList

string

The ID of the list the card should be in

Pattern: ^[0-9a-fA-F]{24}$
idLabels

string

Comma-separated list of label IDs

Style: form, Pattern: ^[0-9a-fA-F]{24}$
idBoard

string

The ID of the board the card should be on

Pattern: ^[0-9a-fA-F]{24}$
pos

oneOf [string, number]

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

due

string

When the card is due, or null

Nullable: true, Format: date
dueComplete

boolean

Whether the due date should be marked complete

subscribed

boolean

Whether the member is should be subscribed to the card

address

string

For use with/by the Map Power-Up

locationName

string

For use with/by the Map Power-Up

coordinates

string

For use with/by the Map Power-Up. Should be latitude,longitude

Example

1
2
3
curl --request PUT \
  --url 'https://api.trello.com/1/cards/{id}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Card

Delete a Card

DELETE /1/cards/{id}

Delete a Card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/cards/{id}'

Responses

Success

A schema has not been defined for this response code.

Get a field on a Card

GET /1/cards/{id}/{field}

Get a specific property of a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
field Required

string

The desired field.

Valid values: id, address, badges, checkItemStates, closed, coordinates, creationMethod, dueComplete, dateLastActivity, desc ...(Show more)

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/{field}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Card

Get Actions on a Card

GET /1/cards/{id}/actions

List the Actions on a Card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
filter

string

A comma-separated list of action types.

Default: commentCard, updateCard:idList

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/actions' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<Action>

Get Attachments on a Card

GET /1/cards/{id}/attachments

List the attachments on a card

Request

Path parameters
fields Required

string

all or a comma-separated list of attachment fields

Default: all
filter Required

string

Use cover to restrict to just the cover attachment

Default: false
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/attachments' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<Attachment>

Add Attachment to Card

POST /1/cards/{id}/attachments

Add an attachment to a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
name

string

The name of the attachment. Max length 256.

file

string

The file to attach, as multipart/form-data

Format: binary
mimeType

string

The mimeType of the attachment. Max length 256

url

string

A URL to attach. Must start with http:// or https://

Example

1
2
3
curl --request POST \
  --url 'https://api.trello.com/1/cards/{id}/attachments' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<Attachment>

Get an Attachment on a Card

GET /1/cards/{id}/attachments/{idAttachment}

Get a specific Attachment on a Card.

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idAttachment Required

string

The ID of the Attachment

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

Array<string>

The Attachment fields to be included in the response.

Style: form

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/attachments/{idAttachment}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<Attachment>

Delete an attachment on a Card

DELETE /1/cards/{id}/attachments/{idAttachment}

Delete an attachment

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idAttachment Required

string

The ID of the Attachment

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/cards/{id}/attachments/{idAttachment}'

Responses

Success

A schema has not been defined for this response code.

Get the Board the Card is on

GET /1/cards/{id}/board

Get the board a card is on

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of board fields

Default: all

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/board'

Responses

Success

A schema has not been defined for this response code.

Get checkItems on a Card

GET /1/cards/{id}/checkItemStates

Get the completed checklist items on a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of: idCheckItem, state

Default: all

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/checkItemStates'

Responses

Success

A schema has not been defined for this response code.

Get Checklists on a Card

GET /1/cards/{id}/checklists

Get the checklists on a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
checkItems

string

all or none

Default: all

Valid values: all, none

checkItem_fields

string

all or a comma-separated list of: name,nameData,pos,state,type

Style: form, Default: name,nameData,pos,state

Valid values: name, nameData, pos, state, type

filter

string

all or none

Default: all

Valid values: all, none

fields

string

all or a comma-separated list of: idBoard,idCard,name,pos

Style: form, Default: all

Valid values: all, name, nameData, pos, state, type

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/checklists'

Responses

Success

A schema has not been defined for this response code.

Create Checklist on a Card

POST /1/cards/{id}/checklists

Create a new checklist on a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
name

string

The name of the checklist

idChecklistSource

string

The ID of a source checklist to copy into the new one

Pattern: ^[0-9a-fA-F]{24}$
pos

string

The position of the checklist on the card. One of: top, bottom, or a positive number.

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/cards/{id}/checklists'

Responses

Success

A schema has not been defined for this response code.

Get checkItem on a Card

GET /1/cards/{id}/checkItem/{idCheckItem}

Get a specific checkItem on a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idCheckItem Required

string

The ID of the checkitem

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of name,nameData,pos,state,type

Default: name,nameData,pos,state

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/checkItem/{idCheckItem}'

Responses

Success

A schema has not been defined for this response code.

Update a checkItem on a Card

PUT /1/cards/{id}/checkItem/{idCheckItem}

Update an item in a checklist on a card.

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idCheckItem Required

string

The ID of the checkitem

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
name

string

The new name for the checklist item

state

string

One of: complete, incomplete

Valid values: complete, incomplete

idChecklist

string

The ID of the checklist this item is in

Pattern: ^[0-9a-fA-F]{24}$
pos

oneOf [string, number]

top, bottom, or a positive float

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/cards/{id}/checkItem/{idCheckItem}'

Responses

Success

A schema has not been defined for this response code.

Delete checkItem on a Card

DELETE /1/cards/{id}/checkItem/{idCheckItem}

Delete a checklist item

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idCheckItem Required

string

The ID of the checkitem

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/cards/{id}/checkItem/{idCheckItem}'

Responses

Success

A schema has not been defined for this response code.

Get the List of a Card

GET /1/cards/{id}/list

Get the list a card is in

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of list fields

Default: all

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/list'

Responses

Success

A schema has not been defined for this response code.

Get the Members of a Card

GET /1/cards/{id}/members

Get the members on a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of member fields

Default: avatarHash,fullName,initials,username

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/members'

Responses

Success

A schema has not been defined for this response code.

Get Members who have voted on a Card

GET /1/cards/{id}/membersVoted

Get the members who have voted on a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of member fields

Default: avatarHash,fullName,initials,username

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/membersVoted'

Responses

Success

A schema has not been defined for this response code.

Add Member vote to Card

POST /1/cards/{id}/membersVoted

Vote on the card for a given member.

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value Required

string

The ID of the member to vote 'yes' on the card

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/cards/{id}/membersVoted?value=5abbe4b7ddc1b351ef961414'

Responses

Success

A schema has not been defined for this response code.

Get pluginData on a Card

GET /1/cards/{id}/pluginData

Get any shared pluginData on a card.

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/pluginData'

Responses

Success

A schema has not been defined for this response code.

Get Stickers on a Card

GET /1/cards/{id}/stickers

Get the stickers on a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of sticker fields

Default: all

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/stickers'

Responses

Success

A schema has not been defined for this response code.

Add a Sticker to a Card

POST /1/cards/{id}/stickers

Add a sticker to a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
image Required

string

For custom stickers, the id of the sticker. For default stickers, the string identifier (like 'taco-cool', see below)

top Required

number

The top position of the sticker, from -60 to 100

Minimum: -60, Maximum: 100, Format: float
left Required

number

The left position of the sticker, from -60 to 100

Minimum: -60, Maximum: 100, Format: float
zIndex Required

integer

The z-index of the sticker

rotate

number

The rotation of the sticker

Default: 0, Minimum: 0, Maximum: 360, Format: float

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/cards/{id}/stickers?image={image}&top={top}&left={left}&zIndex={zIndex}'

Responses

Success

A schema has not been defined for this response code.

Get a Sticker on a Card

GET /1/cards/{id}/stickers/{idSticker}

Get a specific sticker on a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idSticker Required

string

The ID of the sticker

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of sticker fields

Default: all

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/stickers/{idSticker}'

Responses

Success

A schema has not been defined for this response code.

Update a Sticker on a Card

PUT /1/cards/{id}/stickers/{idSticker}

Update a sticker on a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idSticker Required

string

The ID of the sticker

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
top Required

number

The top position of the sticker, from -60 to 100

Minimum: -60, Maximum: 100, Format: float
left Required

number

The left position of the sticker, from -60 to 100

Minimum: -60, Maximum: 100, Format: float
zIndex Required

integer

The z-index of the sticker

rotate

number

The rotation of the sticker

Default: 0, Minimum: 0, Maximum: 360, Format: float

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/cards/{id}/stickers/{idSticker}?top={top}&left={left}&zIndex={zIndex}'

Responses

Success

A schema has not been defined for this response code.

Delete a Sticker on a Card

DELETE /1/cards/{id}/stickers/{idSticker}

Remove a sticker from the card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idSticker Required

string

The ID of the sticker

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/cards/{id}/stickers/{idSticker}'

Responses

Success

A schema has not been defined for this response code.

Update Comment Action on a Card

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

Update an existing comment

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idAction Required

string

The ID of the comment action to update

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
text Required

string

The new text for the comment

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/cards/{id}/actions/{idAction}/comments?text={text}'

Responses

Success

A schema has not been defined for this response code.

Delete a comment on a Card

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

Delete a comment

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idAction Required

string

The ID of the comment action to update

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/cards/{id}/actions/{idAction}/comments'

Responses

Success

A schema has not been defined for this response code.

Update Custom Field item on Card

PUT /1/cards/{idCard}/customField/{idCustomField}/item

Setting, updating, and removing the value for a Custom Field on a card.

Request

Path parameters
idCard Required

string

ID of the card that the Custom Field value should be set/updated for

Pattern: ^[0-9a-fA-F]{24}$
idCustomField Required

string

ID of the Custom Field on the card.

Pattern: ^[0-9a-fA-F]{24}$
Body parameters
Content typeValue
application/json

oneOf [object, object]

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/cards/{idCard}/customField/{idCustomField}/item'

Responses

Success

A schema has not been defined for this response code.

Get Custom Field Items for a Card

GET /1/cards/{id}/customFieldItems

Get the custom field items for a card.

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/cards/{id}/customFieldItems' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<CustomFieldItems>

Update Checkitem on Checklist on Card

PUT /1/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}

Update an item in a checklist on a card.

Request

Path parameters
idCard Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idCheckItem Required

string

The ID of the checklist item to update

Pattern: ^[0-9a-fA-F]{24}$
idChecklist Required

string

The ID of the item to update.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
pos

oneOf [string, number]

top, bottom, or a positive float

Example

1
2
3
curl --request PUT \
  --url 'https://api.trello.com/1/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

CheckItem

Add a new comment to a Card

POST /1/cards/{id}/actions/comments

Add a new comment to a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
text Required

string

The comment

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/cards/{id}/actions/comments?text={text}'

Responses

Success

A schema has not been defined for this response code.

Add a Label to a Card

POST /1/cards/{id}/idLabels

Add a label to a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value

string

The ID of the label to add

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/cards/{id}/idLabels'

Responses

Success

A schema has not been defined for this response code.

Add a Member to a Card

POST /1/cards/{id}/idMembers

Add a member to a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
value

string

The ID of the Member to add to the card

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/cards/{id}/idMembers'

Responses

Success

A schema has not been defined for this response code.

Create a new Label on a Card

POST /1/cards/{id}/labels

Create a new label for the board and add it to the given card.

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
color Required

string

A valid label color or null. See labels

name

string

A name for the label

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/cards/{id}/labels?color={color}'

Responses

Success

A schema has not been defined for this response code.

Mark a Card's Notifications as read

POST /1/cards/{id}/markAssociatedNotificationsRead

Mark notifications about this card as read

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/cards/{id}/markAssociatedNotificationsRead'

Responses

Success

A schema has not been defined for this response code.

Delete a Checklist on a Card

DELETE /1/cards/{id}/checklists/{idChecklist}

Delete a checklist from a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idChecklist Required

string

The ID of the checklist to delete

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/cards/{id}/checklists/{idChecklist}'

Responses

Success

A schema has not been defined for this response code.

Remove a Label from a Card

DELETE /1/cards/{id}/idLabels/{idLabel}

Remove a label from a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idLabel Required

string

The ID of the label to remove

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/cards/{id}/idLabels/{idLabel}'

Responses

Success

A schema has not been defined for this response code.

Remove a Member from a Card

DELETE /1/cards/{id}/idMembers/{idMember}

Remove a member from a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idMember Required

string

The ID of the member to remove from the card

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/cards/{id}/idMembers/{idMember}'

Responses

Success

A schema has not been defined for this response code.

Remove a Member's Vote on a Card

DELETE /1/cards/{id}/membersVoted/{idMember}

Remove a member's vote from a card

Request

Path parameters
id Required

string

The ID of the Card

Pattern: ^[0-9a-fA-F]{24}$
idMember Required

string

The ID of the member whose vote to remove

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/cards/{id}/membersVoted/{idMember}'

Responses

Success

A schema has not been defined for this response code.

Checklists

Create a Checklist

POST /1/checklists

Request

Query parameters
idCard Required

string

The ID of the Card that the checklist should be added to.

Pattern: ^[0-9a-fA-F]{24}$
name

string

The name of the checklist. Should be a string of length 1 to 16384.

Min length: 1, Max length: 16384
pos

oneOf [string, number]

The position of the checklist on the card. One of: top, bottom, or a positive number.

idChecklistSource

string

The ID of a checklist to copy into the new checklist.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/checklists?idCard=5abbe4b7ddc1b351ef961414'

Responses

Success

A schema has not been defined for this response code.

Get a Checklist

GET /1/checklists/{id}

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
cards

string

Valid values: all, closed, none, open, visible. Cards is a nested resource. The additional query params available are documented at Cards Nested Resource.

Default: none

Valid values: all, closed, none, open, visible

checkItems

string

The check items on the list to return. One of: all, none.

Default: all

Valid values: all, none

checkItem_fields

string

The fields on the checkItem to return if checkItems are being returned. all or a comma-separated list of: name, nameData, pos, state, type

Default: name, nameData, pos, state

Valid values: all, name, nameData, pos, state, type

fields

string

all or a comma-separated list of checklist fields

Default: all

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/checklists/{id}'

Responses

Success

A schema has not been defined for this response code.

Update a Checklist

PUT /1/checklists/{id}

Update an existing checklist.

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
name

string

Name of the new checklist being created. Should be length of 1 to 16384.

pos

oneOf [string, number]

Determines the position of the checklist on the card. One of: top, bottom, or a positive number.

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/checklists/{id}'

Responses

Success

A schema has not been defined for this response code.

Delete a Checklist

DELETE /1/checklists/{id}

Delete a checklist

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/checklists/{id}'

Responses

Success

A schema has not been defined for this response code.

Get field on a Checklist

GET /1/checklists/{id}/{field}

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$
field Required

string

Field to update.

Valid values: name, pos

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/checklists/{id}/{field}'

Responses

Success

A schema has not been defined for this response code.

Update field on a Checklist

PUT /1/checklists/{id}/{field}

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$
field Required

string

Field to update.

Valid values: name, pos

Query parameters
value Required

oneOf [oneOf [string, number], string]

The value to change the checklist name to. Should be a string of length 1 to 16384.

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/checklists/{id}/{field}?value={value}'

Responses

Success

A schema has not been defined for this response code.

Get the Board the Checklist is on

GET /1/checklists/{id}/board

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

all or a comma-separated list of board fields

Default: all

Valid values: all, name

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/checklists/{id}/board'

Responses

Success

A schema has not been defined for this response code.

Get the Card a Checklist is on

GET /1/checklists/{id}/cards

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/checklists/{id}/cards'

Responses

Success

A schema has not been defined for this response code.

Get Checkitems on a Checklist

GET /1/checklists/{id}/checkItems

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
filter

string

One of: all, none.

Default: all

Valid values: all, none

fields

string

One of: all, name, nameData, pos, state, type.

Style: form, Default: name, nameData, pos, state

Valid values: all, name, nameData, pos, state, type

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/checklists/{id}/checkItems'

Responses

Success

A schema has not been defined for this response code.

Create Checkitem on Checklist

POST /1/checklists/{id}/checkItems

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
name Required

string

The name of the new check item on the checklist. Should be a string of length 1 to 16384.

Min length: 1, Max length: 16384
pos

oneOf [string, number]

The position of the check item in the checklist. One of: top, bottom, or a positive number.

checked

boolean

Determines whether the check item is already checked when created.

Default: false

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/checklists/{id}/checkItems?name={name}'

Responses

Success

A schema has not been defined for this response code.

Get a Checkitem on a Checklist

GET /1/checklists/{id}/checkItems/{idCheckItem}

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$
idCheckItem Required

string

ID of the check item to retrieve.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

One of: all, name, nameData, pos, state, type.

Style: form, Default: name, nameData, pos, state

Valid values: all, name, nameData, pos, state, type

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/checklists/{id}/checkItems/{idCheckItem}'

Responses

Success

A schema has not been defined for this response code.

Update Checkitem on Card

PUT /1/checklists/{id}/checkItems/{idCheckItem}

Update check item.

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$
idCheckItem Required

string

ID of the check item to retrieve.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
pos Required

integer

Position to move check item to.

Format: int32

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/checklists/{id}/checkItems/{idCheckItem}?pos={pos}'

Responses

Success

A schema has not been defined for this response code.

Delete Checkitem from Checklist

DELETE /1/checklists/{id}/checkItems/{idCheckItem}

Remove an item from a checklist

Request

Path parameters
id Required

string

ID of a checklist.

Pattern: ^[0-9a-fA-F]{24}$
idCheckItem Required

string

ID of the check item to retrieve.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/checklists/{id}/checkItems/{idCheckItem}'

Responses

Success

A schema has not been defined for this response code.

CustomFields

Create a new Custom Field on a Board

POST /1/customFields

Create a new Custom Field on a board.

Request

Body parameters
idModel Required

string

Pattern: ^[0-9a-fA-F]{24}$
modelType Required

string

The type of model that the Custom Field is being defined on. This should always be board.

Valid values: board

name Required

string

The name of the Custom Field

type Required

string

The type of Custom Field to create.

Valid values: checkbox, list, number, text, date

options

string

If the type is checkbox

pos Required

oneOf [string, number]

display_cardFront

boolean

Whether this Custom Field should be shown on the front of Cards

Default: true

Example

1
2
3
curl --request POST \
  --url 'https://api.trello.com/1/customFields' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

CustomField

Get a Custom Field

GET /1/customFields/{id}

Request

Path parameters
id Required

string

ID of the Custom Field.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/customFields/{id}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

CustomField

Update a Custom Field definition

PUT /1/customFields/{id}

Update a Custom Field definition.

Request

Path parameters
id Required

string

ID of the Custom Field.

Pattern: ^[0-9a-fA-F]{24}$
Body parameters
name

string

The name of the Custom Field

pos

oneOf [string, number]

display/cardFront

boolean

Whether to display this custom field on the front of cards

Example

1
2
3
curl --request PUT \
  --url 'https://api.trello.com/1/customFields/{id}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

CustomField

Delete a Custom Field definition

DELETE /1/customFields/{id}

Delete a Custom Field from a board.

Request

Path parameters
id Required

string

ID of the Custom Field.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/customFields/{id}'

Responses

Success

A schema has not been defined for this response code.

Get Options of Custom Field drop down

GET /1/customFields/{id}/options

Get the options of a drop down Custom Field

Request

Path parameters
id Required

string

ID of the customfield.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/customFields/{id}/options'

Responses

Success

A schema has not been defined for this response code.

Add Option to Custom Field dropdown

POST /1/customFields/{id}/options

Add an option to a dropdown Custom Field

Request

Path parameters
id Required

string

ID of the customfield.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/customFields/{id}/options'

Responses

Success

A schema has not been defined for this response code.

Get Option of Custom Field dropdown

GET /1/customFields/{id}/options/{idCustomFieldOption}

Retrieve a specific, existing Option on a given dropdown-type Custom Field

Request

Path parameters
id Required

string

ID of the customfielditem.

Pattern: ^[0-9a-fA-F]{24}$
idCustomFieldOption Required

string

ID of the customfieldoption to retrieve.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/customFields/{id}/options/{idCustomFieldOption}'

Responses

Success

A schema has not been defined for this response code.

Delete Option of Custom Field dropdown

DELETE /1/customFields/{id}/options/{idCustomFieldOption}

Delete an option from a Custom Field dropdown.

Request

Path parameters
id Required

string

ID of the customfielditem.

Pattern: ^[0-9a-fA-F]{24}$
idCustomFieldOption Required

string

ID of the customfieldoption to retrieve.

Pattern: ^[0-9a-fA-F]{24}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/customFields/{id}/options/{idCustomFieldOption}'

Responses

Success

A schema has not been defined for this response code.

Emoji

List available Emoji

GET /1/emoji

List available Emoji

Request

Query parameters
locale

string

The locale to return emoji descriptions and names in. Defaults to the logged in member's locale.

spritesheets

boolean

true to return spritesheet URLs in the response

Default: false

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/emoji' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Emoji

Enterprises

Get an Enterprise

GET /1/enterprises/{id}

Get an enterprise by its ID.

Request

Path parameters
id Required

string

ID of the enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
fields

string

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

Default: all
members

string

One of: none, normal, admins, owners, all

Default: none
member_fields

string

One of: avatarHash, fullName, initials, username

Default: avatarHash, fullName, initials, username
member_filter

string

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.

Default: none
member_sort

string

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

string

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.

Default: none
member_sortOrder

string

Deprecated: Please use member_sort. One of: ascending, descending, asc, desc

Default: id
member_startIndex

integer

Any integer between 0 and 100.

Default: 1, Format: int32
member_count

integer

0 to 100

Default: