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

Clear filters
GET POST PUT PATCH DELETE

Action 2 endpoints

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}
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

Board 31 endpoints

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}
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
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
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
PUT /boards/{idBoard}/members
operationId: Board_updateMembersByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

Attributes of “Boards Members” to be updated.

application/json
schema boards_members
Property Type Required
type string optional
email string optional
fullName string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/members
PUT /boards/{idBoard}/members/{idMember}
operationId: Board_updateMembersByIdBoardByIdMember

Parameters

Name In Required Type Description
idBoard path required string

board_id
idMember path required string

idMember

Request Body

Attributes of “Boards Members” to be updated.

application/json
schema boards_members
Property Type Required
type string optional
email string optional
fullName string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/members/{idMember}
PUT /boards/{idBoard}/memberships/{idMembership}
operationId: Board_updateMembershipsByIdBoardByIdMembership

Parameters

Name In Required Type Description
idBoard path required string

board_id
idMembership path required string

idMembership

Request Body

required

Attributes of “Boards Memberships” to be updated.

application/json
schema boards_memberships
Property Type Required
type string optional
member_fields string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/memberships/{idMembership}
PUT /boards/{idBoard}/myPrefs/emailPosition
operationId: Board_updateMyPrefsEmailPositionByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “My Prefs Email Position” to be updated.

application/json
schema myPrefs_emailPosition
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/myPrefs/emailPosition
PUT /boards/{idBoard}/myPrefs/idEmailList
operationId: Board_updateMyPrefsEmailListByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “My Prefs Id Email List” to be updated.

application/json
schema myPrefs_idEmailList
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/myPrefs/idEmailList
PUT /boards/{idBoard}/myPrefs/showListGuide
operationId: Board_updateMyPrefsShowListGuideByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “My Prefs Show List Guide” to be updated.

application/json
schema myPrefs_showListGuide
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/myPrefs/showListGuide
PUT /boards/{idBoard}/myPrefs/showSidebar
operationId: Board_updateMyPrefsShowSidebar

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “My Prefs Show Sidebar” to be updated.

application/json
schema myPrefs_showSidebar
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/myPrefs/showSidebar
PUT /boards/{idBoard}/myPrefs/showSidebarActivity
operationId: Board_updateMyPrefsShowSidebarActivityByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “My Prefs Show Sidebar Activity” to be updated.

application/json
schema myPrefs_showSidebarActivity
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/myPrefs/showSidebarActivity
PUT /boards/{idBoard}/myPrefs/showSidebarBoardActions
operationId: Board_updateMyPrefsShowSidebarActionsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “My Prefs Show Sidebar Board Actions” to be updated.

application/json
schema myPrefs_showSidebarBoardActions
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/myPrefs/showSidebarBoardActions
PUT /boards/{idBoard}/myPrefs/showSidebarMembers
operationId: Board_updatePrefsShowSidebarMembersById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “My Prefs Show Sidebar Members” to be updated.

application/json
schema myPrefs_showSidebarMembers
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/myPrefs/showSidebarMembers
PUT /boards/{idBoard}/name
operationId: Board_updateNameById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Boards Name” to be updated.

application/json
schema boards_name
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/name
PUT /boards/{idBoard}/prefs/background
operationId: Board_updatePrefsBackgroundByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Prefs Background” to be updated.

application/json
schema prefs_background
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/prefs/background
PUT /boards/{idBoard}/prefs/calendarFeedEnabled
operationId: Board_updatePrefsCalendarFeedEnabledById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Prefs Calendar Feed Enabled” to be updated.

application/json
schema prefs_calendarFeedEnabled
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/prefs/calendarFeedEnabled
PUT /boards/{idBoard}/prefs/cardAging
operationId: Board_updatePrefsCardAgingByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Prefs Card Aging” to be updated.

application/json
schema prefs_cardAging
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/prefs/cardAging
PUT /boards/{idBoard}/prefs/cardCovers
operationId: Board_updatePrefsCardCoversByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Prefs Card Covers” to be updated.

application/json
schema prefs_cardCovers
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/prefs/cardCovers
PUT /boards/{idBoard}/prefs/comments
operationId: Board_updatePrefsCommentsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Prefs Comments” to be updated.

application/json
schema prefs_comments
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/prefs/comments
PUT /boards/{idBoard}/prefs/invitations
operationId: Board_updatePrefsInvitationsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Prefs Invitations” to be updated.

application/json
schema prefs_invitations
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/prefs/invitations
PUT /boards/{idBoard}/prefs/permissionLevel
operationId: Board_updatePrefsPermissionLevelById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

Attributes of “Prefs Permission Level” to be updated.

application/json
schema prefs_permissionLevel
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/prefs/permissionLevel
PUT /boards/{idBoard}/prefs/selfJoin
operationId: Board_updatePrefsSelfJoinByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Prefs Self Join” to be updated.

application/json
schema prefs_selfJoin
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/prefs/selfJoin
PUT /boards/{idBoard}/prefs/voting
operationId: Board_updateVotingPrefsById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Prefs Voting” to be updated.

application/json
schema prefs_voting
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/prefs/voting
PUT /boards/{idBoard}/subscribed
operationId: Board_updateSubscribedById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Request Body

required

Attributes of “Boards Subscribed” to be updated.

application/json
schema boards_subscribed
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /boards/{idBoard}/subscribed

Card 18 endpoints

PUT /cards/{idCard}
operationId: Card_updateByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards” to be updated.

application/json
schema cards
Property Type Required
due string optional
pos string optional
desc string optional
name string optional
closed string optional
idList string optional
labels string optional
idBoard string optional
idLabels string optional
idMembers string optional
urlSource string optional
fileSource string optional
subscribed string optional
idCardSource string optional
keepFromSource string optional
idAttachmentCover string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}
PUT /cards/{idCard}/actions/{idAction}/comments

This can only be done by the original author of the comment.

operationId: Card_updateActionCommentByIdCardByIdAction

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
idAction path required string

idAction

Request Body

required

Attributes of “Cards Actions Comments” to be updated.

application/json
schema cards_actions_comments
Property Type Required
text string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/actions/{idAction}/comments
PUT /cards/{idCard}/checklist/{idChecklistCurrent}/checkItem/{idCheckItem}
operationId: Card_updateChecklistCheckItem

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
idChecklistCurrent path required string

idChecklistCurrent
idCheckItem path required string

idCheckItem

Request Body

required

Attributes of “Cards Checklist Id Checklist Current Check Item” to be updated.

application/json
schema cards_checklist_idChecklistCurrent_checkItem
Property Type Required
pos string optional
name string optional
state string optional
idChecklist string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/checklist/{idChecklistCurrent}/checkItem/{idCheckItem}
PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/name
operationId: Card_updateChecklistCheckItemNameById

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
idChecklist path required string

idChecklist
idCheckItem path required string

idCheckItem

Request Body

required

Attributes of “Cards Checklist Check Item Name” to be updated.

application/json
schema cards_checklist_checkItem_name
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/name
PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/pos
operationId: Card_updateCheckItemPosById

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
idChecklist path required string

idChecklist
idCheckItem path required string

idCheckItem

Request Body

required

Attributes of “Cards Checklist Check Item Pos” to be updated.

application/json
schema cards_checklist_checkItem_pos
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/pos
PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/state
operationId: Card_updateChecklistCheckItemState

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
idChecklist path required string

idChecklist
idCheckItem path required string

idCheckItem

Request Body

required

Attributes of “Cards Checklist Check Item State” to be updated.

application/json
schema cards_checklist_checkItem_state
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/state
PUT /cards/{idCard}/closed
operationId: Card_updateClosedById

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Closed” to be updated.

application/json
schema cards_closed
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/closed
PUT /cards/{idCard}/desc
operationId: Card_updateDescriptionByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Desc” to be updated.

application/json
schema cards_desc
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/desc
PUT /cards/{idCard}/due
operationId: Card_updateDueById

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Due” to be updated.

application/json
schema cards_due
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/due
PUT /cards/{idCard}/idAttachmentCover
operationId: Card_updateAttachmentCoverByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Id Attachment Cover” to be updated.

application/json
schema cards_idAttachmentCover
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/idAttachmentCover
PUT /cards/{idCard}/idBoard
operationId: Card_updateBoardByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Id Board” to be updated.

application/json
schema cards_idBoard
Property Type Required
value string optional
idList string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/idBoard
PUT /cards/{idCard}/idList
operationId: Card_updateIdListByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Id List” to be updated.

application/json
schema cards_idList
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/idList
PUT /cards/{idCard}/idMembers
operationId: Card_updateIdMembers

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Id Members” to be updated.

application/json
schema cards_idMembers
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/idMembers
PUT /cards/{idCard}/labels
operationId: Card_updateLabels

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Labels” to be updated.

application/json
schema cards_labels
Property Type Required
name string optional
color string optional
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/labels
PUT /cards/{idCard}/name
operationId: Card_updateNameById

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Name” to be updated.

application/json
schema cards_name
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/name
PUT /cards/{idCard}/pos
operationId: Card_updatePosByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Pos” to be updated.

application/json
schema cards_pos
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/pos
PUT /cards/{idCard}/stickers/{idSticker}
operationId: Card_updateStickersByIdCardByIdSticker

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
idSticker path required string

idSticker

Request Body

required

Attributes of “Cards Stickers” to be updated.

application/json
schema cards_stickers
Property Type Required
top string optional
left string optional
image string optional
rotate string optional
zIndex string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/stickers/{idSticker}
PUT /cards/{idCard}/subscribed
operationId: Card_updateSubscribedByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink

Request Body

required

Attributes of “Cards Subscribed” to be updated.

application/json
schema cards_subscribed
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /cards/{idCard}/subscribed

Checklist 4 endpoints

PUT /checklists/{idChecklist}
operationId: Checklist_updateByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist

Request Body

required

Attributes of “Checklists” to be updated.

application/json
schema checklists
Property Type Required
pos string optional
name string optional
idCard string optional
idBoard string optional
idChecklistSource string optional

Responses

200

Success
400

Server rejection
PUT /checklists/{idChecklist}
PUT /checklists/{idChecklist}/idCard
operationId: Checklist_updateIdCardByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist

Request Body

required

Attributes of “Checklists Id Card” to be updated.

application/json
schema checklists_idCard
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /checklists/{idChecklist}/idCard
PUT /checklists/{idChecklist}/name
operationId: Checklist_updateNameByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist

Request Body

required

Attributes of “Checklists Name” to be updated.

application/json
schema checklists_name
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /checklists/{idChecklist}/name
PUT /checklists/{idChecklist}/pos
operationId: Checklist_updatePosByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist

Request Body

required

Attributes of “Checklists Pos” to be updated.

application/json
schema checklists_pos
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /checklists/{idChecklist}/pos

Label 3 endpoints

PUT /labels/{idLabel}
operationId: Label_updateByIdLabel

Parameters

Name In Required Type Description
idLabel path required string

idLabel

Request Body

required

Attributes of “Labels” to be updated.

application/json
schema labels
Property Type Required
name string optional
color string optional
idBoard string optional

Responses

200

Success
400

Server rejection
PUT /labels/{idLabel}
PUT /labels/{idLabel}/color
operationId: Label_updateColorByIdLabel

Parameters

Name In Required Type Description
idLabel path required string

idLabel

Request Body

required

Attributes of “Labels Color” to be updated.

application/json
schema labels_color
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /labels/{idLabel}/color
PUT /labels/{idLabel}/name
operationId: Label_updateNameByIdLabel

Parameters

Name In Required Type Description
idLabel path required string

idLabel

Request Body

required

Attributes of “Labels Name” to be updated.

application/json
schema labels_name
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /labels/{idLabel}/name

List 6 endpoints

PUT /lists/{idList}
operationId: List_updateByIdList

Parameters

Name In Required Type Description
idList path required string

idList

Request Body

required

Attributes of “Lists” to be updated.

application/json
schema lists
Property Type Required
pos string optional
name string optional
closed string optional
idBoard string optional
subscribed string optional
idListSource string optional

Responses

200

Success
400

Server rejection
PUT /lists/{idList}
PUT /lists/{idList}/closed
operationId: List_updateClosedByIdList

Parameters

Name In Required Type Description
idList path required string

idList

Request Body

required

Attributes of “Lists Closed” to be updated.

application/json
schema lists_closed
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /lists/{idList}/closed
PUT /lists/{idList}/idBoard
operationId: List_updateIdBoardByIdList

Parameters

Name In Required Type Description
idList path required string

idList

Request Body

required

Attributes of “Lists Id Board” to be updated.

application/json
schema lists_idBoard
Property Type Required
pos string optional
value string optional

Responses

200

Success
400

Server rejection
PUT /lists/{idList}/idBoard
PUT /lists/{idList}/name
operationId: List_updateNameByIdList

Parameters

Name In Required Type Description
idList path required string

idList

Request Body

required

Attributes of “Lists Name” to be updated.

application/json
schema lists_name
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /lists/{idList}/name
PUT /lists/{idList}/pos
operationId: List_updatePosByIdList

Parameters

Name In Required Type Description
idList path required string

idList

Request Body

required

Attributes of “Lists Pos” to be updated.

application/json
schema lists_pos
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /lists/{idList}/pos
PUT /lists/{idList}/subscribed
operationId: List_updateSubscribedByIdList

Parameters

Name In Required Type Description
idList path required string

idList

Request Body

required

Attributes of “Lists Subscribed” to be updated.

application/json
schema lists_subscribed
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /lists/{idList}/subscribed

Member 18 endpoints

PUT /members/{idMember}
operationId: Member_updateByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Request Body

required

Attributes of “Members” to be updated.

application/json
schema members
Property Type Required
bio string optional
fullName string optional
initials string optional
username string optional
avatarSource string optional
prefs/locale string optional
prefs/colorBlind string optional
prefs/minutesBetweenSummaries string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}
PUT /members/{idMember}/avatarSource
operationId: Member_updateAvatarSource

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Request Body

required

Attributes of “Members Avatar Source” to be updated.

application/json
schema members_avatarSource
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/avatarSource
PUT /members/{idMember}/bio
operationId: Member_updateBioById

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Request Body

required

Attributes of “Members Bio” to be updated.

application/json
schema members_bio
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/bio
PUT /members/{idMember}/boardBackgrounds/{idBoardBackground}
operationId: Member_updateBoardBackgroundsById

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idBoardBackground path required string

idBoardBackground

Request Body

required

Attributes of “Members Board Backgrounds” to be updated.

application/json
schema members_boardBackgrounds
Property Type Required
file string optional
tile string optional
brightness string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/boardBackgrounds/{idBoardBackground}
PUT /members/{idMember}/boardStars/{idBoardStar}
operationId: Member_updateBoardStar

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idBoardStar path required string

idBoardStar

Request Body

required

Attributes of “Members Board Stars” to be updated.

application/json
schema members_boardStars
Property Type Required
pos string optional
idBoard string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/boardStars/{idBoardStar}
PUT /members/{idMember}/boardStars/{idBoardStar}/idBoard
operationId: Member_updateBoardStarsIdBoard

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idBoardStar path required string

idBoardStar

Request Body

required

Attributes of “Members Board Stars Id Board” to be updated.

application/json
schema members_boardStars_idBoard
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/boardStars/{idBoardStar}/idBoard
PUT /members/{idMember}/boardStars/{idBoardStar}/pos
operationId: Member_updateBoardStarPosByIdMemberByIdBoardStar

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idBoardStar path required string

idBoardStar

Request Body

required

Attributes of “Members Board Stars Pos” to be updated.

application/json
schema members_boardStars_pos
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/boardStars/{idBoardStar}/pos
PUT /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
operationId: Member_updateCustomBoardBackgrounds

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idBoardBackground path required string

idBoardBackground

Request Body

required

Attributes of “Members Custom Board Backgrounds” to be updated.

application/json
schema members_customBoardBackgrounds
Property Type Required
file string optional
tile string optional
brightness string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
PUT /members/{idMember}/fullName
operationId: Member_updateFullName

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Request Body

required

Attributes of “Members Full Name” to be updated.

application/json
schema members_fullName
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/fullName
PUT /members/{idMember}/initials
operationId: Member_updateInitialsByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Request Body

required

Attributes of “Members Initials” to be updated.

application/json
schema members_initials
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/initials
PUT /members/{idMember}/prefs/colorBlind
operationId: Member_updatePrefsColorBlindByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Request Body

required

Attributes of “Prefs Color Blind” to be updated.

application/json
schema prefs_colorBlind
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/prefs/colorBlind
PUT /members/{idMember}/prefs/locale
operationId: Member_updatePrefsLocaleByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Request Body

required

Attributes of “Prefs Locale” to be updated.

application/json
schema prefs_locale
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/prefs/locale
PUT /members/{idMember}/prefs/minutesBetweenSummaries
operationId: Member_updatePrefsMinutesBetweenSummariesById

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Request Body

required

Attributes of “Prefs Minutes Between Summaries” to be updated.

application/json
schema prefs_minutesBetweenSummaries
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/prefs/minutesBetweenSummaries
PUT /members/{idMember}/savedSearches/{idSavedSearch}
operationId: Member_updateSavedSearchesByIdMemberByIdSavedSearch

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idSavedSearch path required string

idSavedSearch

Request Body

required

Attributes of “Members Saved Searches” to be updated.

application/json
schema members_savedSearches
Property Type Required
pos string optional
name string optional
query string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/savedSearches/{idSavedSearch}
PUT /members/{idMember}/savedSearches/{idSavedSearch}/name
operationId: Member_updateSavedSearchesNameByIdMemberByIdSavedSearch

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idSavedSearch path required string

idSavedSearch

Request Body

required

Attributes of “Members Saved Searches Name” to be updated.

application/json
schema members_savedSearches_name
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/savedSearches/{idSavedSearch}/name
PUT /members/{idMember}/savedSearches/{idSavedSearch}/pos
operationId: Member_updateSavedSearchesPosByIdMemberByIdSavedSearch

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idSavedSearch path required string

idSavedSearch

Request Body

required

Attributes of “Members Saved Searches Pos” to be updated.

application/json
schema members_savedSearches_pos
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/savedSearches/{idSavedSearch}/pos
PUT /members/{idMember}/savedSearches/{idSavedSearch}/query
operationId: Member_updateSavedSearchQueryByIdMemberByIdSavedSearch

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idSavedSearch path required string

idSavedSearch

Request Body

required

Attributes of “Members Saved Searches Query” to be updated.

application/json
schema members_savedSearches_query
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/savedSearches/{idSavedSearch}/query
PUT /members/{idMember}/username
operationId: Member_updateUsernameById

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Request Body

required

Attributes of “Members Username” to be updated.

application/json
schema members_username
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /members/{idMember}/username

Notification 2 endpoints

PUT /notifications/{idNotification}
operationId: Notification_updateByIdNotification

Parameters

Name In Required Type Description
idNotification path required string

idNotification

Request Body

required

Attributes of “Notifications” to be updated.

application/json
schema notifications
Property Type Required
unread string optional

Responses

200

Success
400

Server rejection
PUT /notifications/{idNotification}
PUT /notifications/{idNotification}/unread
operationId: Notification_updateUnreadByIdNotification

Parameters

Name In Required Type Description
idNotification path required string

idNotification

Request Body

required

Attributes of “Notifications Unread” to be updated.

application/json
schema notifications_unread
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /notifications/{idNotification}/unread

Organization 17 endpoints

PUT /organizations/{idOrg}
operationId: Organization_updateByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

required

Attributes of “Organizations” to be updated.

application/json
schema organizations
Property Type Required
desc string optional
name string optional
website string optional
displayName string optional
prefs/permissionLevel string optional
prefs/associatedDomain string optional
prefs/googleAppsVersion string optional
prefs/orgInviteRestrict string optional
prefs/externalMembersDisabled string optional
prefs/boardVisibilityRestrict/org string optional
prefs/boardVisibilityRestrict/public string optional
prefs/boardVisibilityRestrict/private string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}
PUT /organizations/{idOrg}/desc
operationId: Organization_updateDescriptionByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

required

Attributes of “Organizations Desc” to be updated.

application/json
schema organizations_desc
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/desc
PUT /organizations/{idOrg}/displayName
operationId: Organization_updateDisplayNameByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

required

Attributes of “Organizations Display Name” to be updated.

application/json
schema organizations_displayName
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/displayName
PUT /organizations/{idOrg}/members
operationId: Organization_updateMembersByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

Attributes of “Organizations Members” to be updated.

application/json
schema organizations_members
Property Type Required
type string optional
email string optional
fullName string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/members
PUT /organizations/{idOrg}/members/{idMember}
operationId: Organization_updateMembersByIdOrgByIdMember

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
idMember path required string

idMember

Request Body

Attributes of “Organizations Members” to be updated.

application/json
schema organizations_members
Property Type Required
type string optional
email string optional
fullName string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/members/{idMember}
PUT /organizations/{idOrg}/members/{idMember}/deactivated
operationId: Organization_updateMembersDeactivatedByIdOrgByIdMember

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
idMember path required string

idMember

Request Body

required

Attributes of “Organizations Members Deactivated” to be updated.

application/json
schema organizations_members_deactivated
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/members/{idMember}/deactivated
PUT /organizations/{idOrg}/memberships/{idMembership}
operationId: Organization_updateMembershipByIdOrgByIdMembership

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
idMembership path required string

idMembership

Request Body

required

Attributes of “Organizations Memberships” to be updated.

application/json
schema organizations_memberships
Property Type Required
type string optional
member_fields string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/memberships/{idMembership}
PUT /organizations/{idOrg}/name
operationId: Organization_updateNameByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

required

Attributes of “Organizations Name” to be updated.

application/json
schema organizations_name
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/name
PUT /organizations/{idOrg}/prefs/associatedDomain
operationId: Organization_updatePrefsAssociatedDomainByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

required

Attributes of “Prefs Associated Domain” to be updated.

application/json
schema prefs_associatedDomain
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/prefs/associatedDomain
PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/org
operationId: Organization_updatePrefsBoardVisibilityRestrictByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

Attributes of “Prefs Board Visibility Restrict” to be updated.

application/json
schema prefs_boardVisibilityRestrict
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/org
PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/private
operationId: Organization_updatePrefsVisibilityByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

Attributes of “Prefs Board Visibility Restrict” to be updated.

application/json
schema prefs_boardVisibilityRestrict
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/private
PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/public
operationId: Organization_updatePrefsBoardVisibilityRestrictPublicByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

Attributes of “Prefs Board Visibility Restrict” to be updated.

application/json
schema prefs_boardVisibilityRestrict
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/public
PUT /organizations/{idOrg}/prefs/externalMembersDisabled
operationId: Organization_updatePrefsExternalMembersDisabledByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

required

Attributes of “Prefs External Members Disabled” to be updated.

application/json
schema prefs_externalMembersDisabled
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/prefs/externalMembersDisabled
PUT /organizations/{idOrg}/prefs/googleAppsVersion
operationId: Organization_updatePrefsGoogleAppsVersionByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

required

Attributes of “Prefs Google Apps Version” to be updated.

application/json
schema prefs_googleAppsVersion
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/prefs/googleAppsVersion
PUT /organizations/{idOrg}/prefs/orgInviteRestrict
operationId: Organization_updatePrefsOrgInviteRestrictByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

required

Attributes of “Prefs Org Invite Restrict” to be updated.

application/json
schema prefs_orgInviteRestrict
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/prefs/orgInviteRestrict
PUT /organizations/{idOrg}/prefs/permissionLevel
operationId: Organization_updatePrefsPermissionLevelByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

Attributes of “Prefs Permission Level” to be updated.

application/json
schema prefs_permissionLevel
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/prefs/permissionLevel
PUT /organizations/{idOrg}/website
operationId: Organization_updateWebsiteByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name

Request Body

required

Attributes of “Organizations Website” to be updated.

application/json
schema organizations_website
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /organizations/{idOrg}/website

Session 2 endpoints

PUT /sessions/{idSession}
operationId: Session_updateStatusByIdSession

Parameters

Name In Required Type Description
idSession path required string

idSession

Request Body

required

Attributes of “Sessions” to be updated.

application/json
schema sessions
Property Type Required
status string optional
idBoard string optional

Responses

200

Success
400

Server rejection
PUT /sessions/{idSession}
PUT /sessions/{idSession}/status
operationId: Session_updateStatusByIdSession

Parameters

Name In Required Type Description
idSession path required string

idSession

Request Body

required

Attributes of “Sessions Status” to be updated.

application/json
schema sessions_status
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /sessions/{idSession}/status

Token 1 endpoints

PUT /tokens/{token}/webhooks
operationId: Token_updateWebhooksByToken

Request Body

required

Attributes of “Tokens Webhooks” to be updated.

application/json
schema tokens_webhooks
Property Type Required
idModel string optional
callbackURL string optional
description string optional

Responses

200

Success
400

Server rejection
PUT /tokens/{token}/webhooks

Webhook 6 endpoints

PUT /webhooks
operationId: Webhook_update

Request Body

Attributes of “Webhooks” to be updated.

application/json
schema webhooks
Property Type Required
active string optional
idModel string optional
callbackURL string optional
description string optional

Responses

200

Success
400

Server rejection
PUT /webhooks
PUT /webhooks/{idWebhook}
operationId: Webhook_updateByIdWebhook

Parameters

Name In Required Type Description
idWebhook path required string

idWebhook

Request Body

Attributes of “Webhooks” to be updated.

application/json
schema webhooks
Property Type Required
active string optional
idModel string optional
callbackURL string optional
description string optional

Responses

200

Success
400

Server rejection
PUT /webhooks/{idWebhook}
PUT /webhooks/{idWebhook}/active
operationId: Webhook_updateActiveById

Parameters

Name In Required Type Description
idWebhook path required string

idWebhook

Request Body

required

Attributes of “Webhooks Active” to be updated.

application/json
schema webhooks_active
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /webhooks/{idWebhook}/active
PUT /webhooks/{idWebhook}/callbackURL
operationId: Webhook_updateCallbackUrlById

Parameters

Name In Required Type Description
idWebhook path required string

idWebhook

Request Body

required

Attributes of “Webhooks Callback Url” to be updated.

application/json
schema webhooks_callbackURL
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /webhooks/{idWebhook}/callbackURL
PUT /webhooks/{idWebhook}/description
operationId: Webhook_updateDescriptionByIdWebhook

Parameters

Name In Required Type Description
idWebhook path required string

idWebhook

Request Body

required

Attributes of “Webhooks Description” to be updated.

application/json
schema webhooks_description
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /webhooks/{idWebhook}/description
PUT /webhooks/{idWebhook}/idModel
operationId: Webhook_updateModelById

Parameters

Name In Required Type Description
idWebhook path required string

idWebhook

Request Body

required

Attributes of “Webhooks Id Model” to be updated.

application/json
schema webhooks_idModel
Property Type Required
value string optional

Responses

200

Success
400

Server rejection
PUT /webhooks/{idWebhook}/idModel
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