openapi.city
Sign in

Trello

Visual project management and collaboration

developer.atlassian.com/cloud/trello/rest ↗
Version
1.0
OpenAPI
3.0.0
Endpoints
323
Schemas
122
80
Quality
Updated
3 days ago
Project management project-management kanban collaboration
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://trello.com/1

Endpoints

GET POST PUT PATCH DELETE

Action 19 endpoints

DELETE /actions/{idAction}
operationId: Action_removeByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction

Responses

200

Success
400

Server rejection
DELETE /actions/{idAction}
GET /actions/{idAction}
operationId: Action_getById

Parameters

Name In Required Type Description
idAction path required string

idAction
display query optional string

true or false
entities query optional string

true or false
fields query optional string

all or a comma-separated list of: data, date, idMemberCreator or type
member query optional string

true or false
member_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
memberCreator query optional string

true or false
memberCreator_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username

Responses

200

Success
400

Server rejection
GET /actions/{idAction}
PUT /actions/{idAction}
operationId: Action_updateByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction

Request Body

required

Attributes of “Actions” to be updated.

application/json
schema actions
Property Type Required
text string optional

Responses

200

Success
400

Server rejection
PUT /actions/{idAction}
GET /actions/{idAction}/board
operationId: Action_getBoardByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

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 or url

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/board
GET /actions/{idAction}/board/{field}
operationId: Action_getBoardByIdActionByField

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/board/{field}
GET /actions/{idAction}/card
operationId: Action_getCardByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

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 or url

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/card
GET /actions/{idAction}/card/{field}
operationId: Action_getCardByIdActionByField

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/card/{field}
GET /actions/{idAction}/display
operationId: Action_getDisplayByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/display
GET /actions/{idAction}/entities
operationId: Action_getEntitiesByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/entities
GET /actions/{idAction}/list
operationId: Action_getListByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/list
GET /actions/{idAction}/list/{field}
operationId: Action_getListByIdActionByField

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/list/{field}
GET /actions/{idAction}/member
operationId: Action_getMemberByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/member
GET /actions/{idAction}/member/{field}
operationId: Action_getMemberByField

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/member/{field}
GET /actions/{idAction}/memberCreator
operationId: Action_getMemberCreatorByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/memberCreator
GET /actions/{idAction}/memberCreator/{field}
operationId: Action_getMemberByIdActionByField

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/memberCreator/{field}
GET /actions/{idAction}/organization
operationId: Action_getOrganizationByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/organization
GET /actions/{idAction}/organization/{field}
operationId: Action_getOrgByIdActionByField

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/organization/{field}
PUT /actions/{idAction}/text
operationId: Action_updateTextByIdAction

Parameters

Name In Required Type Description
idAction path required string

idAction

Request Body

required

Attributes of “Actions Text” to be updated.

application/json
schema actions_text
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /actions/{idAction}/text
GET /actions/{idAction}/{field}
operationId: Action_getByIdActionField

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

Server rejection
GET /actions/{idAction}/{field}

Batch 1 endpoints

GET /batch
operationId: Batch_getData

Parameters

Name In Required Type Description
urls query required string

list of API v1 GET routes, not including the version prefix

Responses

200

Success
400

Server rejection
GET /batch

Board 30 endpoints

POST /boards
operationId: Board_createBoard

Request Body

required

Attributes of “Boards” to be added.

application/json
schema boards
Property Type Required
desc string optional
name string optional
closed string optional
powerUps string optional
subscribed string optional
prefs/voting string optional
prefs_voting string optional
idBoardSource string optional
idOrganization string optional
keepFromSource string optional
labelNames/red string optional
prefs/comments string optional
prefs/selfJoin string optional
prefs_comments string optional
prefs_selfJoin string optional
labelNames/blue string optional
prefs/cardAging string optional
prefs_cardAging string optional
labelNames/green string optional
prefs/background string optional
…11 more object optional

Responses

200

Success
400

Server rejection
POST /boards
GET /boards/{idBoard}
operationId: Board_getById

Parameters

Name In Required Type Description
idBoard path required string

board_id
actions query optional string

all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization
actions_entities query optional string

true or false
actions_display query optional string

true or false
actions_format query optional string

One of: count, list or minimal
actions_since query optional string

A date, null or lastView
actions_limit query optional string

a number from 0 to 1000
action_fields query optional string

all or a comma-separated list of: data, date, idMemberCreator or type
action_member query optional string

true or false
action_member_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
action_memberCreator query optional string

true or false
action_memberCreator_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
cards query optional string

One of: all, closed, none, open or visible
card_fields query optional string

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 or url
card_attachments query optional string

A boolean value or "cover" for only card cover attachments
card_attachment_fields query optional string

all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url
card_checklists query optional string

One of: all or none
card_stickers query optional string

true or false
boardStars query optional string

One of: mine or none
labels query optional string

One of: all or none
label_fields query optional string

all or a comma-separated list of: color, idBoard, name or uses
labels_limit query optional string

a number from 0 to 1000
lists query optional string

One of: all, closed, none or open
list_fields query optional string

all or a comma-separated list of: closed, idBoard, name, pos or subscribed
memberships query optional string

all or a comma-separated list of: active, admin, deactivated, me or normal
memberships_member query optional string

true or false
memberships_member_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
members query optional string

One of: admins, all, none, normal or owners
member_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
membersInvited query optional string

One of: admins, all, none, normal or owners
membersInvited_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
checklists query optional string

One of: all or none
checklist_fields query optional string

all or a comma-separated list of: idBoard, idCard, name or pos
organization query optional string

true or false
organization_fields query optional string

all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website
organization_memberships query optional string

all or a comma-separated list of: active, admin, deactivated, me or normal
myPrefs query optional string

true or false
fields query optional string

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 or url

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}
PUT /boards/{idBoard}
operationId: Board_updateById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Boards” to be updated.

application/json
schema boards
Property Type Required
desc string optional
name string optional
closed string optional
powerUps string optional
subscribed string optional
prefs/voting string optional
prefs_voting string optional
idBoardSource string optional
idOrganization string optional
keepFromSource string optional
labelNames/red string optional
prefs/comments string optional
prefs/selfJoin string optional
prefs_comments string optional
prefs_selfJoin string optional
labelNames/blue string optional
prefs/cardAging string optional
prefs_cardAging string optional
labelNames/green string optional
prefs/background string optional
…11 more object optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}
GET /boards/{idBoard}/actions
operationId: Board_listActionsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
entities query optional string

true or false
display query optional string

true or false
filter query optional string

all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization
fields query optional string

all or a comma-separated list of: data, date, idMemberCreator or type
limit query optional string

a number from 0 to 1000
format query optional string

One of: count, list or minimal
since query optional string

A date, null or lastView
before query optional string

A date, or null
page query optional string

Page * limit must be less than 1000
idModels query optional string

Only return actions related to these model ids
member query optional string

true or false
member_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
memberCreator query optional string

true or false
memberCreator_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/actions
GET /boards/{idBoard}/boardStars
operationId: Board_getBoardStarsById

Parameters

Name In Required Type Description
idBoard path required string

board_id
filter query optional string

One of: mine or none

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/boardStars
POST /boards/{idBoard}/calendarKey/generate
operationId: Board_generateCalendarKeyById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Responses

200

Success
400

Server rejection
POST /boards/{idBoard}/calendarKey/generate
GET /boards/{idBoard}/cards
operationId: Board_getCardsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
actions query optional string

all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization
attachments query optional string

A boolean value or "cover" for only card cover attachments
attachment_fields query optional string

all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url
stickers query optional string

true or false
members query optional string

true or false
member_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
checkItemStates query optional string

true or false
checklists query optional string

One of: all or none
limit query optional string

a number from 1 to 1000
since query optional string

A date, or null
before query optional string

A date, or null
filter query optional string

One of: all, closed, none, open or visible
fields query optional string

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 or url

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/cards
GET /boards/{idBoard}/cards/{filter}
operationId: Board_filterCardsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
filter path required string

filter

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/cards/{filter}
GET /boards/{idBoard}/cards/{idCard}
operationId: Board_getCardsByIdBoardByIdCard

Parameters

Name In Required Type Description
idBoard path required string

board_id
idCard path required string

idCard
attachments query optional string

A boolean value or "cover" for only card cover attachments
attachment_fields query optional string

all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url
actions query optional string

all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization
actions_entities query optional string

true or false
actions_display query optional string

true or false
actions_limit query optional string

a number from 0 to 1000
action_fields query optional string

all or a comma-separated list of: data, date, idMemberCreator or type
action_memberCreator_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
members query optional string

true or false
member_fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
checkItemStates query optional string

true or false
checkItemState_fields query optional string

all or a comma-separated list of: idCheckItem or state
labels query optional string

true or false
checklists query optional string

One of: all or none
checklist_fields query optional string

all or a comma-separated list of: idBoard, idCard, name or pos
fields query optional string

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 or url

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/cards/{idCard}
GET /boards/{idBoard}/checklists
operationId: Board_getChecklistsById

Parameters

Name In Required Type Description
idBoard path required string

board_id
cards query optional string

One of: all, closed, none, open or visible
card_fields query optional string

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 or url
checkItems query optional string

One of: all or none
checkItem_fields query optional string

all or a comma-separated list of: name, nameData, pos, state or type
filter query optional string

One of: all or none
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/checklists
POST /boards/{idBoard}/checklists
operationId: Board_addChecklists

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Boards Checklists” to be added.

application/json
schema boards_checklists
Property Type Required
name string optional

Responses

200

Success
400

Server rejection
POST /boards/{idBoard}/checklists
PUT /boards/{idBoard}/closed
operationId: Board_updateClosedById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Boards Closed” to be updated.

application/json
schema boards_closed
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/closed
GET /boards/{idBoard}/deltas
operationId: Board_getDeltasByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
tags query required string

A valid tag for subscribing
ixLastUpdate query required string

a number from -1 to Infinity

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/deltas
PUT /boards/{idBoard}/desc
operationId: Board_updateDescriptionByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Boards Desc” to be updated.

application/json
schema boards_desc
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/desc
POST /boards/{idBoard}/emailKey/generate
operationId: Board_generateEmailKey

Parameters

Name In Required Type Description
idBoard path required string

board_id

Responses

200

Success
400

Server rejection
POST /boards/{idBoard}/emailKey/generate
PUT /boards/{idBoard}/idOrganization
operationId: Board_updateOrganizationByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Boards Id Organization” to be updated.

application/json
schema boards_idOrganization
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/idOrganization
PUT /boards/{idBoard}/labelNames/blue
operationId: Board_updateLabelNamesBlueById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Label Names Blue” to be updated.

application/json
schema labelNames_blue
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/labelNames/blue
PUT /boards/{idBoard}/labelNames/green
operationId: Board_updateLabelNamesGreenByIdBoardPut

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Label Names Green” to be updated.

application/json
schema labelNames_green
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/labelNames/green
PUT /boards/{idBoard}/labelNames/orange
operationId: Board_updateLabelNamesOrangeByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Label Names Orange” to be updated.

application/json
schema labelNames_orange
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/labelNames/orange
PUT /boards/{idBoard}/labelNames/purple
operationId: Board_updateLabelNamesPurpleByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Label Names Purple” to be updated.

application/json
schema labelNames_purple
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/labelNames/purple
PUT /boards/{idBoard}/labelNames/red
operationId: Board_updateLabelNamesRed

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Label Names Red” to be updated.

application/json
schema labelNames_red
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/labelNames/red
PUT /boards/{idBoard}/labelNames/yellow
operationId: Board_updateLabelNamesYellowByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Label Names Yellow” to be updated.

application/json
schema labelNames_yellow
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/labelNames/yellow
GET /boards/{idBoard}/labels
operationId: Board_listLabelsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
fields query optional string

all or a comma-separated list of: color, idBoard, name or uses
limit query optional string

a number from 0 to 1000

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/labels
POST /boards/{idBoard}/labels
operationId: Board_addLabelsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Boards Labels” to be added.

application/json
schema boards_labels
Property Type Required
name string optional
color string optional

Responses

200

Success
400

Server rejection
POST /boards/{idBoard}/labels
GET /boards/{idBoard}/labels/{idLabel}
operationId: Board_getLabelsByIdBoardByIdLabel

Parameters

Name In Required Type Description
idBoard path required string

board_id
idLabel path required string

idLabel
fields query optional string

all or a comma-separated list of: color, idBoard, name or uses

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/labels/{idLabel}
GET /boards/{idBoard}/lists
operationId: Board_getListsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
cards query optional string

One of: all, closed, none, open or visible
card_fields query optional string

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 or url
filter query optional string

One of: all, closed, none or open
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/lists
POST /boards/{idBoard}/lists
operationId: Board_createListsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Boards Lists” to be added.

application/json
schema boards_lists
Property Type Required
pos string optional
name string optional

Responses

200

Success
400

Server rejection
POST /boards/{idBoard}/lists
GET /boards/{idBoard}/lists/{filter}
operationId: Board_getListsByFilter

Parameters

Name In Required Type Description
idBoard path required string

board_id
filter path required string

filter

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/lists/{filter}
POST /boards/{idBoard}/markAsViewed
operationId: Board_markAsViewedByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Responses

200

Success
400

Server rejection
POST /boards/{idBoard}/markAsViewed
GET /boards/{idBoard}/members
operationId: Board_getMembersByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
filter query optional string

One of: admins, all, none, normal or owners
fields query optional string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username
activity query optional string

true or false ; works for premium organizations only.

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/members
Load more endpoints

Schemas

object actions 
{
  "xml": {
    "name": "action"
  },
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object actions_comments 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object actions_text 
{
  "xml": {
    "name": "action"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object boards 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "desc": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "name": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    },
    "closed": {
      "type": "string",
      "description": " true or false"
    },
    "powerUps": {
      "type": "string",
      "description": "all or a comma-separated list of: calendar, cardAging, recap or voting"
    },
    "subscribed": {
      "type": "string",
      "description": " true or false"
    },
    "prefs/voting": {
      "type": "string",
      "description": "One of: disabled, members, observers, org or public"
    },
    "prefs_voting": {
      "type": "string",
      "description": "One of: disabled, members, observers, org or public"
    },
    "idBoardSource": {
      "type": "string",
      "description": "The id of the board to copy into the new board"
    },
    "idOrganization": {
      "type": "string",
      "description": "The id or name of the organization to add the board to."
    },
    "keepFromSource": {
      "type": "string",
      "description": "Components of the source board to copy."
    },
    "labelNames/red": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "prefs/comments": {
      "type": "string",
      "description": "One of: disabled, members, observers, org or public"
    },
    "prefs/selfJoin": {
      "type": "string",
      "description": " true or false"
    },
    "prefs_comments": {
      "type": "string",
      "description": "One of: disabled, members, observers, org or public"
    },
    "prefs_selfJoin": {
      "type": "string",
      "description": " true or false"
    },
    "labelNames/blue": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "prefs/cardAging": {
      "type": "string",
      "description": "One of: pirate or regular"
    },
    "prefs_cardAging": {
      "type": "string",
      "description": "One of: pirate or regular"
    },
    "labelNames/green": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "prefs/background": {
      "type": "string",
      "description": "A standard background name, or the id of a custom background"
    },
    "prefs/cardCovers": {
      "type": "string",
      "description": " true or false"
    },
    "prefs_background": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "prefs_cardCovers": {
      "type": "string",
      "description": " true or false"
    },
    "labelNames/orange": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "labelNames/purple": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "labelNames/yellow": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "prefs/invitations": {
      "type": "string",
      "description": "One of: admins or members"
    },
    "prefs_invitations": {
      "type": "string",
      "description": "One of: admins or members"
    },
    "prefs/permissionLevel": {
      "type": "string",
      "description": "One of: org, private or public"
    },
    "prefs_permissionLevel": {
      "type": "string",
      "description": "One of: org, private or public"
    },
    "prefs/calendarFeedEnabled": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object boards_checklists 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object boards_closed 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object boards_desc 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object boards_idOrganization 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object boards_labels 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "color": {
      "type": "string",
      "description": "A valid label color or null"
    }
  }
}
object boards_lists 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "pos": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    },
    "name": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object boards_members 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "One of: admin, normal or observer"
    },
    "email": {
      "type": "string",
      "description": "An email address"
    },
    "fullName": {
      "type": "string",
      "description": "A string with a length of at least 1.  Cannot begin or end with a space."
    }
  }
}
object boards_memberships 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "One of: admin, normal or observer"
    },
    "member_fields": {
      "type": "string",
      "description": "all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"
    }
  }
}
object boards_name 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object boards_powerUps 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: calendar, cardAging, recap or voting"
    }
  }
}
object boards_subscribed 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object cards 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "due": {
      "type": "string",
      "description": "A date, or null"
    },
    "pos": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    },
    "desc": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "name": {
      "type": "string",
      "description": "The name of the new card.  It isn't required if the name is being copied from provided by a URL, file or card that is being copied."
    },
    "closed": {
      "type": "string",
      "description": " true or false"
    },
    "idList": {
      "type": "string",
      "description": "id of the list that the card should be added to"
    },
    "labels": {
      "type": "string",
      "description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
    },
    "idBoard": {
      "type": "string",
      "description": "id of the board the card should be moved to"
    },
    "idLabels": {
      "type": "string",
      "description": "A comma-separated list of objectIds, 24-character hex strings"
    },
    "idMembers": {
      "type": "string",
      "description": "A comma-separated list of objectIds, 24-character hex strings"
    },
    "urlSource": {
      "type": "string",
      "description": "A URL starting with http:// or https:// or null"
    },
    "fileSource": {
      "type": "string",
      "description": "A file"
    },
    "subscribed": {
      "type": "string",
      "description": " true or false"
    },
    "idCardSource": {
      "type": "string",
      "description": "The id of the card to copy into a new card."
    },
    "keepFromSource": {
      "type": "string",
      "description": "Properties of the card to copy over from the source."
    },
    "idAttachmentCover": {
      "type": "string",
      "description": "Id of the image attachment of this card to use as its cover, or null for no cover"
    }
  }
}
object cards_actions_comments 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object cards_attachments 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "A URL starting with http:// or https:// or null"
    },
    "file": {
      "type": "string",
      "description": "A file"
    },
    "name": {
      "type": "string",
      "description": "a string with a length from 0 to 256"
    },
    "mimeType": {
      "type": "string",
      "description": "a string with a length from 0 to 256"
    }
  }
}
object cards_checklist_checkItem 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "pos": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    },
    "name": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object cards_checklist_checkItem_name 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object cards_checklist_checkItem_pos 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    }
  }
}
object cards_checklist_checkItem_state 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: complete, false, incomplete or true"
    }
  }
}
object cards_checklist_idChecklistCurrent_checkItem 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "pos": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    },
    "name": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    },
    "state": {
      "type": "string",
      "description": "One of: complete, false, incomplete or true"
    },
    "idChecklist": {
      "type": "string",
      "description": "An id, or null"
    }
  }
}
object cards_checklists 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "value": {
      "type": "string",
      "description": "The id of the checklist to add to the card, or null to create a new one."
    },
    "idChecklistSource": {
      "type": "string",
      "description": "The id of the source checklist to copy into a new checklist."
    }
  }
}
object cards_closed 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object cards_desc 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object cards_due 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A date, or null"
    }
  }
}
object cards_idAttachmentCover 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "Id of the image attachment of this card to use as its cover, or null for no cover"
    }
  }
}
object cards_idBoard 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "id of the board the card should be moved to"
    },
    "idList": {
      "type": "string",
      "description": "id of the list that the card should be moved to on the new board"
    }
  }
}
object cards_idLabels 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "The id of the label to add"
    }
  }
}
object cards_idList 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "id of the list the card should be moved to"
    }
  }
}
object cards_idMembers 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "The id of the member to add to the card"
    }
  }
}
object cards_labels 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "color": {
      "type": "string",
      "description": "A valid label color or null"
    },
    "value": {
      "type": "string",
      "description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
    }
  }
}
object cards_membersVoted 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "The id of the member to vote 'yes' on the card"
    }
  }
}
object cards_name 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object cards_pos 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    }
  }
}
object cards_stickers 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "top": {
      "type": "string",
      "description": "undefined"
    },
    "left": {
      "type": "string",
      "description": "undefined"
    },
    "image": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "rotate": {
      "type": "string",
      "description": "undefined"
    },
    "zIndex": {
      "type": "string",
      "description": "Valid Z values for stickers, must be an integer"
    }
  }
}
object cards_subscribed 
{
  "xml": {
    "name": "card"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object checklists 
{
  "xml": {
    "name": "checklist"
  },
  "type": "object",
  "properties": {
    "pos": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    },
    "name": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "idCard": {
      "type": "string",
      "description": "id of the card that the checklist should be added to"
    },
    "idBoard": {
      "type": "string",
      "description": "id of the board that the checklist should be added to"
    },
    "idChecklistSource": {
      "type": "string",
      "description": "The id of the source checklist to copy into a new checklist."
    }
  }
}
object checklists_checkItems 
{
  "xml": {
    "name": "checklist"
  },
  "type": "object",
  "properties": {
    "pos": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    },
    "name": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    },
    "checked": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object checklists_idCard 
{
  "xml": {
    "name": "checklist"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "The id of the card that the checklist is on"
    }
  }
}
object checklists_name 
{
  "xml": {
    "name": "checklist"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object checklists_pos 
{
  "xml": {
    "name": "checklist"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    }
  }
}
object labelNames_blue 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object labelNames_green 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object labelNames_orange 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object labelNames_purple 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object labelNames_red 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object labelNames_yellow 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object labels 
{
  "xml": {
    "name": "label"
  },
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "color": {
      "type": "string",
      "description": "A valid label color or null"
    },
    "idBoard": {
      "type": "string",
      "description": "An id"
    }
  }
}
Load more schemas

Versions

Version Endpoints Schemas Ingested Status
1.0 323 122 2026-05-11 current
1.0 323 122 2026-04-16