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

Authentication

apiKey apiKey

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/actions"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Actions\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/actions_text"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Actions Text\" to be updated."
}

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 64 endpoints

POST /boards
operationId: Board_createBoard

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards\" to be added."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards_checklists"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards Checklists\" to be added."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards_closed"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards Closed\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards_desc"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards Desc\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards_idOrganization"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards Id Organization\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/labelNames_blue"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Label Names Blue\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/labelNames_green"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Label Names Green\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/labelNames_orange"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Label Names Orange\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/labelNames_purple"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Label Names Purple\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/labelNames_red"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Label Names Red\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/labelNames_yellow"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Label Names Yellow\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards_labels"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards Labels\" to be added."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards_lists"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards Lists\" to be added."
}

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

Parameters

Name In Required Type Description
idBoard path required string board_id

Request Body

{
  "$ref": "#/components/requestBodies/boards_members"
}

Responses

200 Success
400 Server rejection
PUT /boards/{idBoard}/members
GET /boards/{idBoard}/members/{filter}
operationId: Board_getMembersByFilter

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}/members/{filter}
DELETE /boards/{idBoard}/members/{idMember}
operationId: Board_removeMember

Parameters

Name In Required Type Description
idBoard path required string board_id
idMember path required string idMember

Responses

200 Success
400 Server rejection
DELETE /boards/{idBoard}/members/{idMember}
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

{
  "$ref": "#/components/requestBodies/boards_members"
}

Responses

200 Success
400 Server rejection
PUT /boards/{idBoard}/members/{idMember}
GET /boards/{idBoard}/members/{idMember}/cards
operationId: Board_getMembersCardsByIdBoardByIdMember

Parameters

Name In Required Type Description
idBoard path required string board_id
idMember path required string idMember
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
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
board query optional string true or false
board_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
list query optional string true or false
list_fields query optional string all or a comma-separated list of: closed, idBoard, name, pos or subscribed
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}/members/{idMember}/cards
GET /boards/{idBoard}/membersInvited
operationId: Board_getMembersInvitedByIdBoard

Parameters

Name In Required Type Description
idBoard path required string board_id
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 /boards/{idBoard}/membersInvited
GET /boards/{idBoard}/membersInvited/{field}
operationId: Board_getMembersInvitedByField

Parameters

Name In Required Type Description
idBoard path required string board_id
field path required string field

Responses

200 Success
400 Server rejection
GET /boards/{idBoard}/membersInvited/{field}
GET /boards/{idBoard}/memberships
operationId: Board_getMembershipsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string board_id
filter query optional string all or a comma-separated list of: active, admin, deactivated, me or normal
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

Responses

200 Success
400 Server rejection
GET /boards/{idBoard}/memberships
GET /boards/{idBoard}/memberships/{idMembership}
operationId: Board_getMembershipsByIdBoardByIdMembership

Parameters

Name In Required Type Description
idBoard path required string board_id
idMembership path required string idMembership
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

Responses

200 Success
400 Server rejection
GET /boards/{idBoard}/memberships/{idMembership}
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards_memberships"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards Memberships\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /boards/{idBoard}/memberships/{idMembership}
GET /boards/{idBoard}/myPrefs
operationId: Board_getMyPrefsById

Parameters

Name In Required Type Description
idBoard path required string board_id

Responses

200 Success
400 Server rejection
GET /boards/{idBoard}/myPrefs
PUT /boards/{idBoard}/myPrefs/emailPosition
operationId: Board_updateMyPrefsEmailPositionByIdBoard

Parameters

Name In Required Type Description
idBoard path required string board_id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/myPrefs_emailPosition"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"My Prefs Email Position\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/myPrefs_idEmailList"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"My Prefs Id Email List\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/myPrefs_showListGuide"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"My Prefs Show List Guide\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/myPrefs_showSidebar"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"My Prefs Show Sidebar\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/myPrefs_showSidebarActivity"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"My Prefs Show Sidebar Activity\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/myPrefs_showSidebarBoardActions"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"My Prefs Show Sidebar Board Actions\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/myPrefs_showSidebarMembers"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"My Prefs Show Sidebar Members\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards_name"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards Name\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /boards/{idBoard}/name
GET /boards/{idBoard}/organization
operationId: Board_getOrganizationById

Parameters

Name In Required Type Description
idBoard path required string board_id
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 /boards/{idBoard}/organization
GET /boards/{idBoard}/organization/{field}
operationId: Board_getOrganizationByIdBoardByField

Parameters

Name In Required Type Description
idBoard path required string board_id
field path required string field

Responses

200 Success
400 Server rejection
GET /boards/{idBoard}/organization/{field}
POST /boards/{idBoard}/powerUps
operationId: Board_addPowerUpsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string board_id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards_powerUps"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards Power Ups\" to be added."
}

Responses

200 Success
400 Server rejection
POST /boards/{idBoard}/powerUps
DELETE /boards/{idBoard}/powerUps/{powerUp}
operationId: Board_removePowerUp

Parameters

Name In Required Type Description
idBoard path required string board_id
powerUp path required string powerUp

Responses

200 Success
400 Server rejection
DELETE /boards/{idBoard}/powerUps/{powerUp}
PUT /boards/{idBoard}/prefs/background
operationId: Board_updatePrefsBackgroundByIdBoard

Parameters

Name In Required Type Description
idBoard path required string board_id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_background"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Background\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_calendarFeedEnabled"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Calendar Feed Enabled\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_cardAging"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Card Aging\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_cardCovers"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Card Covers\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_comments"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Comments\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_invitations"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Invitations\" to be updated."
}

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

{
  "$ref": "#/components/requestBodies/prefs_permissionLevel"
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_selfJoin"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Self Join\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_voting"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Voting\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/boards_subscribed"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Boards Subscribed\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /boards/{idBoard}/subscribed
GET /boards/{idBoard}/{field}
operationId: Board_getByIdField

Parameters

Name In Required Type Description
idBoard path required string board_id
field path required string field

Responses

200 Success
400 Server rejection
GET /boards/{idBoard}/{field}

Card 55 endpoints

POST /cards
operationId: Card_createAndUpdate

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards\" to be added."
}

Responses

200 Success
400 Server rejection
POST /cards
DELETE /cards/{idCard}
operationId: Card_removeByIdCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Responses

200 Success
400 Server rejection
DELETE /cards/{idCard}
GET /cards/{idCard}
operationId: Card_getById

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
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
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
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
membersVoted query optional string true or false
memberVoted_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
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
board query optional string true or false
board_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
list query optional string true or false
list_fields query optional string all or a comma-separated list of: closed, idBoard, name, pos or subscribed
stickers query optional string true or false
sticker_fields query optional string all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex
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 /cards/{idCard}
PUT /cards/{idCard}
operationId: Card_updateByIdCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /cards/{idCard}
GET /cards/{idCard}/actions
operationId: Card_listCardActionsById

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
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 /cards/{idCard}/actions
POST /cards/{idCard}/actions/comments
operationId: Card_addActionsCommentsByIdCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/actions_comments"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Actions Comments\" to be added."
}

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/actions/comments
DELETE /cards/{idCard}/actions/{idAction}/comments

This can only be done by the original author of the comment, or someone with higher permissions than the original author.

operationId: Card_removeActionCommentByIdCardByIdAction

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idAction path required string idAction

Responses

200 Success
400 Server rejection
DELETE /cards/{idCard}/actions/{idAction}/comments
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_actions_comments"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Actions Comments\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /cards/{idCard}/actions/{idAction}/comments
GET /cards/{idCard}/attachments
operationId: Card_getAttachmentsByIdCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
fields query optional string all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url
filter query optional string A boolean value or "cover" for only card cover attachments

Responses

200 Success
400 Server rejection
GET /cards/{idCard}/attachments
POST /cards/{idCard}/attachments
operationId: Card_addAttachmentsByIdCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_attachments"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Attachments\" to be added."
}

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/attachments
DELETE /cards/{idCard}/attachments/{idAttachment}
operationId: Card_deleteAttachmentsByIdCardByIdAttachment

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idAttachment path required string idAttachment

Responses

200 Success
400 Server rejection
DELETE /cards/{idCard}/attachments/{idAttachment}
GET /cards/{idCard}/attachments/{idAttachment}
operationId: Card_getAttachmentsByIds

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idAttachment path required string idAttachment
fields query optional string all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url

Responses

200 Success
400 Server rejection
GET /cards/{idCard}/attachments/{idAttachment}
GET /cards/{idCard}/board
operationId: Card_getBoardById

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
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 /cards/{idCard}/board
GET /cards/{idCard}/board/{field}
operationId: Card_getBoardByIdCardByField

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
field path required string field

Responses

200 Success
400 Server rejection
GET /cards/{idCard}/board/{field}
GET /cards/{idCard}/checkItemStates
operationId: Card_getCheckItemStatesById

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
fields query optional string all or a comma-separated list of: idCheckItem or state

Responses

200 Success
400 Server rejection
GET /cards/{idCard}/checkItemStates
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_checklist_idChecklistCurrent_checkItem"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Checklist Id Checklist Current Check Item\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /cards/{idCard}/checklist/{idChecklistCurrent}/checkItem/{idCheckItem}
POST /cards/{idCard}/checklist/{idChecklist}/checkItem
operationId: Card_addChecklistCheckItem

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idChecklist path required string idChecklist

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_checklist_checkItem"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Checklist Check Item\" to be added."
}

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/checklist/{idChecklist}/checkItem
DELETE /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}
operationId: Card_removeChecklistCheckItem

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idChecklist path required string idChecklist
idCheckItem path required string idCheckItem

Responses

200 Success
400 Server rejection
DELETE /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}
POST /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/convertToCard
operationId: Card_convertCheckItemToCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idChecklist path required string idChecklist
idCheckItem path required string idCheckItem

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/convertToCard
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_checklist_checkItem_name"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Checklist Check Item Name\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_checklist_checkItem_pos"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Checklist Check Item Pos\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_checklist_checkItem_state"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Checklist Check Item State\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/state
GET /cards/{idCard}/checklists
operationId: Card_getChecklistsById

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
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 /cards/{idCard}/checklists
POST /cards/{idCard}/checklists
operationId: Card_addChecklists

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_checklists"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Checklists\" to be added."
}

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/checklists
DELETE /cards/{idCard}/checklists/{idChecklist}
operationId: Card_deleteChecklistByIdCardByIdChecklist

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idChecklist path required string idChecklist

Responses

200 Success
400 Server rejection
DELETE /cards/{idCard}/checklists/{idChecklist}
PUT /cards/{idCard}/closed
operationId: Card_updateClosedById

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_closed"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Closed\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_desc"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Desc\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_due"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Due\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_idAttachmentCover"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Id Attachment Cover\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_idBoard"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Id Board\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /cards/{idCard}/idBoard
POST /cards/{idCard}/idLabels
operationId: Card_addIdLabelsToCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_idLabels"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Id Labels\" to be added."
}

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/idLabels
DELETE /cards/{idCard}/idLabels/{idLabel}
operationId: Card_removeLabelByIdCardByIdLabel

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idLabel path required string idLabel

Responses

200 Success
400 Server rejection
DELETE /cards/{idCard}/idLabels/{idLabel}
PUT /cards/{idCard}/idList
operationId: Card_updateIdListByIdCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_idList"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Id List\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /cards/{idCard}/idList
POST /cards/{idCard}/idMembers
operationId: Card_addMembers

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_idMembers"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Id Members\" to be added."
}

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/idMembers
PUT /cards/{idCard}/idMembers
operationId: Card_updateIdMembers

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_idMembers"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Id Members\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /cards/{idCard}/idMembers
DELETE /cards/{idCard}/idMembers/{idMember}
operationId: Card_removeMemberByIdMember

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idMember path required string idMember

Responses

200 Success
400 Server rejection
DELETE /cards/{idCard}/idMembers/{idMember}
POST /cards/{idCard}/labels
operationId: Card_addLabels

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_labels"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Labels\" to be added."
}

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/labels
PUT /cards/{idCard}/labels
operationId: Card_updateLabels

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_labels"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Labels\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /cards/{idCard}/labels
DELETE /cards/{idCard}/labels/{color}
operationId: Card_removeLabelsByIdCardByColor

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
color path required string color

Responses

200 Success
400 Server rejection
DELETE /cards/{idCard}/labels/{color}
GET /cards/{idCard}/list
operationId: Card_getListById

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
fields query optional string all or a comma-separated list of: closed, idBoard, name, pos or subscribed

Responses

200 Success
400 Server rejection
GET /cards/{idCard}/list
GET /cards/{idCard}/list/{field}
operationId: Card_getCardsListByIdCardByField

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
field path required string field

Responses

200 Success
400 Server rejection
GET /cards/{idCard}/list/{field}
POST /cards/{idCard}/markAssociatedNotificationsRead
operationId: Card_markAssociatedNotificationsRead

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/markAssociatedNotificationsRead
GET /cards/{idCard}/members
operationId: Card_listMembersByIdCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
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 /cards/{idCard}/members
GET /cards/{idCard}/membersVoted
operationId: Card_getMembersVotedByIdCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
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 /cards/{idCard}/membersVoted
POST /cards/{idCard}/membersVoted
operationId: Card_addMembersVoted

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_membersVoted"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Members Voted\" to be added."
}

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/membersVoted
DELETE /cards/{idCard}/membersVoted/{idMember}
operationId: Card_removeMembersVotedByIdCardByIdMember

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idMember path required string idMember

Responses

200 Success
400 Server rejection
DELETE /cards/{idCard}/membersVoted/{idMember}
PUT /cards/{idCard}/name
operationId: Card_updateNameById

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_name"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Name\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_pos"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Pos\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /cards/{idCard}/pos
GET /cards/{idCard}/stickers
operationId: Card_getStickersByIdCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
fields query optional string all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex

Responses

200 Success
400 Server rejection
GET /cards/{idCard}/stickers
POST /cards/{idCard}/stickers
operationId: Card_addStickersByIdCard

Parameters

Name In Required Type Description
idCard path required string card id or shortlink

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_stickers"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Stickers\" to be added."
}

Responses

200 Success
400 Server rejection
POST /cards/{idCard}/stickers
DELETE /cards/{idCard}/stickers/{idSticker}
operationId: Card_removeStickerByIds

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idSticker path required string idSticker

Responses

200 Success
400 Server rejection
DELETE /cards/{idCard}/stickers/{idSticker}
GET /cards/{idCard}/stickers/{idSticker}
operationId: Card_getStickerByIds

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
idSticker path required string idSticker
fields query optional string all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex

Responses

200 Success
400 Server rejection
GET /cards/{idCard}/stickers/{idSticker}
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_stickers"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Stickers\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/cards_subscribed"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Cards Subscribed\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /cards/{idCard}/subscribed
GET /cards/{idCard}/{field}
operationId: Card_getByIdField

Parameters

Name In Required Type Description
idCard path required string card id or shortlink
field path required string field

Responses

200 Success
400 Server rejection
GET /cards/{idCard}/{field}

Checklist 16 endpoints

POST /checklists
operationId: Checklist_create

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/checklists"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Checklists\" to be added."
}

Responses

200 Success
400 Server rejection
POST /checklists
DELETE /checklists/{idChecklist}
operationId: Checklist_removeById

Parameters

Name In Required Type Description
idChecklist path required string idChecklist

Responses

200 Success
400 Server rejection
DELETE /checklists/{idChecklist}
GET /checklists/{idChecklist}
operationId: Checklist_getById

Parameters

Name In Required Type Description
idChecklist path required string idChecklist
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
fields query optional string all or a comma-separated list of: idBoard, idCard, name or pos

Responses

200 Success
400 Server rejection
GET /checklists/{idChecklist}
PUT /checklists/{idChecklist}
operationId: Checklist_updateByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string idChecklist

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/checklists"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Checklists\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /checklists/{idChecklist}
GET /checklists/{idChecklist}/board
operationId: Checklist_getBoardByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string idChecklist
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 /checklists/{idChecklist}/board
GET /checklists/{idChecklist}/board/{field}
operationId: Checklist_getBoardByIdChecklistByField

Parameters

Name In Required Type Description
idChecklist path required string idChecklist
field path required string field

Responses

200 Success
400 Server rejection
GET /checklists/{idChecklist}/board/{field}
GET /checklists/{idChecklist}/cards
operationId: Checklist_listCardsByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string idChecklist
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 or open
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 /checklists/{idChecklist}/cards
GET /checklists/{idChecklist}/cards/{filter}
operationId: Checklist_getCardsByFilter

Parameters

Name In Required Type Description
idChecklist path required string idChecklist
filter path required string filter

Responses

200 Success
400 Server rejection
GET /checklists/{idChecklist}/cards/{filter}
GET /checklists/{idChecklist}/checkItems
operationId: Checklist_getCheckItemsByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string idChecklist
filter query optional string One of: all or none
fields query optional string all or a comma-separated list of: name, nameData, pos, state or type

Responses

200 Success
400 Server rejection
GET /checklists/{idChecklist}/checkItems
POST /checklists/{idChecklist}/checkItems
operationId: Checklist_addCheckItemsByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string idChecklist

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/checklists_checkItems"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Checklists Check Items\" to be added."
}

Responses

200 Success
400 Server rejection
POST /checklists/{idChecklist}/checkItems
DELETE /checklists/{idChecklist}/checkItems/{idCheckItem}
operationId: Checklist_removeByIdCheckItem

Parameters

Name In Required Type Description
idChecklist path required string idChecklist
idCheckItem path required string idCheckItem

Responses

200 Success
400 Server rejection
DELETE /checklists/{idChecklist}/checkItems/{idCheckItem}
GET /checklists/{idChecklist}/checkItems/{idCheckItem}
operationId: Checklist_getCheckItemsByIdChecklistByIdCheckItem

Parameters

Name In Required Type Description
idChecklist path required string idChecklist
idCheckItem path required string idCheckItem
fields query optional string all or a comma-separated list of: name, nameData, pos, state or type

Responses

200 Success
400 Server rejection
GET /checklists/{idChecklist}/checkItems/{idCheckItem}
PUT /checklists/{idChecklist}/idCard
operationId: Checklist_updateIdCardByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string idChecklist

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/checklists_idCard"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Checklists Id Card\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/checklists_name"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Checklists Name\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/checklists_pos"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Checklists Pos\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /checklists/{idChecklist}/pos
GET /checklists/{idChecklist}/{field}
operationId: Checklist_getByIdField

Parameters

Name In Required Type Description
idChecklist path required string idChecklist
field path required string field

Responses

200 Success
400 Server rejection
GET /checklists/{idChecklist}/{field}

Label 8 endpoints

POST /labels
operationId: Label_createLabels

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/labels"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Labels\" to be added."
}

Responses

200 Success
400 Server rejection
POST /labels
DELETE /labels/{idLabel}
operationId: Label_removeByIdLabel

Parameters

Name In Required Type Description
idLabel path required string idLabel

Responses

200 Success
400 Server rejection
DELETE /labels/{idLabel}
GET /labels/{idLabel}
operationId: Label_getByIdLabel

Parameters

Name In Required Type Description
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 /labels/{idLabel}
PUT /labels/{idLabel}
operationId: Label_updateByIdLabel

Parameters

Name In Required Type Description
idLabel path required string idLabel

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/labels"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Labels\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /labels/{idLabel}
GET /labels/{idLabel}/board
operationId: Label_getBoardByIdLabel

Parameters

Name In Required Type Description
idLabel path required string idLabel
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 /labels/{idLabel}/board
GET /labels/{idLabel}/board/{field}
operationId: Label_getBoardByIdLabelByField

Parameters

Name In Required Type Description
idLabel path required string idLabel
field path required string field

Responses

200 Success
400 Server rejection
GET /labels/{idLabel}/board/{field}
PUT /labels/{idLabel}/color
operationId: Label_updateColorByIdLabel

Parameters

Name In Required Type Description
idLabel path required string idLabel

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/labels_color"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Labels Color\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/labels_name"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Labels Name\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /labels/{idLabel}/name

List 17 endpoints

POST /lists
operationId: List_createList

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/lists"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Lists\" to be added."
}

Responses

200 Success
400 Server rejection
POST /lists
GET /lists/{idList}
operationId: List_getByIdList

Parameters

Name In Required Type Description
idList path required string idList
cards query optional string One of: all, closed, none or open
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
board query optional string true or false
board_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
fields query optional string all or a comma-separated list of: closed, idBoard, name, pos or subscribed

Responses

200 Success
400 Server rejection
GET /lists/{idList}
PUT /lists/{idList}
operationId: List_updateByIdList

Parameters

Name In Required Type Description
idList path required string idList

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/lists"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Lists\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /lists/{idList}
GET /lists/{idList}/actions
operationId: List_getActionsByIdList

Parameters

Name In Required Type Description
idList path required string idList
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 /lists/{idList}/actions
POST /lists/{idList}/archiveAllCards
operationId: List_archiveAllCardsByIdList

Parameters

Name In Required Type Description
idList path required string idList

Responses

200 Success
400 Server rejection
POST /lists/{idList}/archiveAllCards
GET /lists/{idList}/board
operationId: List_idBoardGet

Parameters

Name In Required Type Description
idList path required string idList
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 /lists/{idList}/board
GET /lists/{idList}/board/{field}
operationId: List_getBoardByIdListByField

Parameters

Name In Required Type Description
idList path required string idList
field path required string field

Responses

200 Success
400 Server rejection
GET /lists/{idList}/board/{field}
GET /lists/{idList}/cards
operationId: List_getCardsByIdList

Parameters

Name In Required Type Description
idList path required string idList
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 or open
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 /lists/{idList}/cards
POST /lists/{idList}/cards
operationId: List_createCardsByIdList

Parameters

Name In Required Type Description
idList path required string idList

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/lists_cards"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Lists Cards\" to be added."
}

Responses

200 Success
400 Server rejection
POST /lists/{idList}/cards
GET /lists/{idList}/cards/{filter}
operationId: List_getCardsByFilter

Parameters

Name In Required Type Description
idList path required string idList
filter path required string filter

Responses

200 Success
400 Server rejection
GET /lists/{idList}/cards/{filter}
PUT /lists/{idList}/closed
operationId: List_updateClosedByIdList

Parameters

Name In Required Type Description
idList path required string idList

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/lists_closed"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Lists Closed\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/lists_idBoard"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Lists Id Board\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /lists/{idList}/idBoard
POST /lists/{idList}/moveAllCards
operationId: List_moveAllCardsByIdList

Parameters

Name In Required Type Description
idList path required string idList

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/lists_moveAllCards"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Lists Move All Cards\" to be added."
}

Responses

200 Success
400 Server rejection
POST /lists/{idList}/moveAllCards
PUT /lists/{idList}/name
operationId: List_updateNameByIdList

Parameters

Name In Required Type Description
idList path required string idList

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/lists_name"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Lists Name\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/lists_pos"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Lists Pos\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/lists_subscribed"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Lists Subscribed\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /lists/{idList}/subscribed
GET /lists/{idList}/{field}
operationId: List_getByIdListByField

Parameters

Name In Required Type Description
idList path required string idList
field path required string field

Responses

200 Success
400 Server rejection
GET /lists/{idList}/{field}

Member 60 endpoints

GET /members/{idMember}

If you specify 'me' as the username, this call will respond as if you had supplied the username associated with the supplied token

operationId: Member_getById

Parameters

Name In Required Type Description
idMember path required string idMember or username
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_since query optional string A date, null or lastView
action_before query optional string A date, or null
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_members query optional string true or false
card_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
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_stickers query optional string true or false
boards query optional string all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned
board_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
board_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
board_actions_entities query optional string true or false
board_actions_display query optional string true or false
board_actions_format query optional string One of: count, list or minimal
board_actions_since query optional string A date, null or lastView
board_actions_limit query optional string a number from 0 to 1000
board_action_fields query optional string all or a comma-separated list of: data, date, idMemberCreator or type
board_lists query optional string One of: all, closed, none or open
board_memberships query optional string all or a comma-separated list of: active, admin, deactivated, me or normal
board_organization query optional string true or false
board_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
boardsInvited query optional string all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned
boardsInvited_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
boardStars query optional string true or false
savedSearches query optional string true or false
organizations query optional string One of: all, members, none or public
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_paid_account query optional string true or false
organizationsInvited query optional string One of: all, members, none or public
organizationsInvited_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
notifications query optional string all or a comma-separated list of: addAdminToBoard, addAdminToOrganization, addedAttachmentToCard, addedMemberToCard, addedToBoard, addedToCard, addedToOrganization, cardDueSoon, changeCard, closeBoard, commentCard, createdCard, declinedInvitationToBoard, declinedInvitationToOrganization, invitedToBoard, invitedToOrganization, makeAdminOfBoard, makeAdminOfOrganization, memberJoinedTrello, mentionedOnCard, removedFromBoard, removedFromCard, removedFromOrganization, removedMemberFromCard, unconfirmedInvitedToBoard, unconfirmedInvitedToOrganization or updateCheckItemStateOnCard
notifications_entities query optional string true or false
notifications_display query optional string true or false
notifications_limit query optional string a number from 1 to 1000
notification_fields query optional string all or a comma-separated list of: data, date, idMemberCreator, type or unread
notification_memberCreator query optional string true or false
notification_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
notification_before query optional string An id, or null
notification_since query optional string An id, or null
tokens query optional string One of: all or none
paid_account query optional string true or false
boardBackgrounds query optional string One of: all, custom, default, none or premium
customBoardBackgrounds query optional string One of: all or none
customStickers query optional string One of: all or none
customEmoji query optional string One of: all or none
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 /members/{idMember}
PUT /members/{idMember}
operationId: Member_updateByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /members/{idMember}
GET /members/{idMember}/actions
operationId: Member_listActionsByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username
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 /members/{idMember}/actions
POST /members/{idMember}/avatar
operationId: Member_uploadAvatarById

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_avatar"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Avatar\" to be added."
}

Responses

200 Success
400 Server rejection
POST /members/{idMember}/avatar
PUT /members/{idMember}/avatarSource
operationId: Member_updateAvatarSource

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_avatarSource"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Avatar Source\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_bio"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Bio\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /members/{idMember}/bio
GET /members/{idMember}/boardBackgrounds
operationId: Member_getBoardBackgroundsById

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter query optional string One of: all, custom, default, none or premium

Responses

200 Success
400 Server rejection
GET /members/{idMember}/boardBackgrounds
POST /members/{idMember}/boardBackgrounds
operationId: Member_addBoardBackgrounds

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_boardBackgrounds"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Board Backgrounds\" to be added."
}

Responses

200 Success
400 Server rejection
POST /members/{idMember}/boardBackgrounds
DELETE /members/{idMember}/boardBackgrounds/{idBoardBackground}
operationId: Member_deleteBoardBackground

Parameters

Name In Required Type Description
idMember path required string idMember or username
idBoardBackground path required string idBoardBackground

Responses

200 Success
400 Server rejection
DELETE /members/{idMember}/boardBackgrounds/{idBoardBackground}
GET /members/{idMember}/boardBackgrounds/{idBoardBackground}
operationId: Member_getBoardBackgroundByIds

Parameters

Name In Required Type Description
idMember path required string idMember or username
idBoardBackground path required string idBoardBackground
fields query optional string all or a comma-separated list of: brightness, fullSizeUrl, scaled or tile

Responses

200 Success
400 Server rejection
GET /members/{idMember}/boardBackgrounds/{idBoardBackground}
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_boardBackgrounds"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Board Backgrounds\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /members/{idMember}/boardBackgrounds/{idBoardBackground}
GET /members/{idMember}/boardStars
operationId: Member_getBoardStarsById

Parameters

Name In Required Type Description
idMember path required string idMember or username

Responses

200 Success
400 Server rejection
GET /members/{idMember}/boardStars
POST /members/{idMember}/boardStars
operationId: Member_addBoardStarsByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_boardStars"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Board Stars\" to be added."
}

Responses

200 Success
400 Server rejection
POST /members/{idMember}/boardStars
DELETE /members/{idMember}/boardStars/{idBoardStar}
operationId: Member_removeBoardStarByIdMemberByIdBoardStar

Parameters

Name In Required Type Description
idMember path required string idMember or username
idBoardStar path required string idBoardStar

Responses

200 Success
400 Server rejection
DELETE /members/{idMember}/boardStars/{idBoardStar}
GET /members/{idMember}/boardStars/{idBoardStar}
operationId: Member_getBoardStarByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username
idBoardStar path required string idBoardStar

Responses

200 Success
400 Server rejection
GET /members/{idMember}/boardStars/{idBoardStar}
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_boardStars"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Board Stars\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_boardStars_idBoard"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Board Stars Id Board\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_boardStars_pos"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Board Stars Pos\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /members/{idMember}/boardStars/{idBoardStar}/pos
GET /members/{idMember}/boards
operationId: Member_getBoardsByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter query optional string all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned
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
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_limit query optional string a number from 0 to 1000
actions_format query optional string One of: count, list or minimal
actions_since query optional string A date, null or lastView
action_fields query optional string all or a comma-separated list of: data, date, idMemberCreator or type
memberships query optional string all or a comma-separated list of: active, admin, deactivated, me or normal
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
lists query optional string One of: all, closed, none or open

Responses

200 Success
400 Server rejection
GET /members/{idMember}/boards
GET /members/{idMember}/boards/{filter}
operationId: Member_getBoards

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter path required string filter

Responses

200 Success
400 Server rejection
GET /members/{idMember}/boards/{filter}
GET /members/{idMember}/boardsInvited
operationId: Member_getInvitedBoards

Parameters

Name In Required Type Description
idMember path required string idMember or username
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 /members/{idMember}/boardsInvited
GET /members/{idMember}/boardsInvited/{field}
operationId: Member_getBoardsInvitedByIdMemberByField

Parameters

Name In Required Type Description
idMember path required string idMember or username
field path required string field

Responses

200 Success
400 Server rejection
GET /members/{idMember}/boardsInvited/{field}
GET /members/{idMember}/cards
operationId: Member_getCardsByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username
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 /members/{idMember}/cards
GET /members/{idMember}/cards/{filter}
operationId: Member_getCardsByFilter

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter path required string filter

Responses

200 Success
400 Server rejection
GET /members/{idMember}/cards/{filter}
GET /members/{idMember}/customBoardBackgrounds
operationId: Member_getCustomBoardBackgroundsById

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter query optional string One of: all or none

Responses

200 Success
400 Server rejection
GET /members/{idMember}/customBoardBackgrounds
POST /members/{idMember}/customBoardBackgrounds
operationId: Member_addCustomBoardBackgrounds

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_customBoardBackgrounds"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Custom Board Backgrounds\" to be added."
}

Responses

200 Success
400 Server rejection
POST /members/{idMember}/customBoardBackgrounds
DELETE /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
operationId: Member_removeCustomBoardBackgroundById

Parameters

Name In Required Type Description
idMember path required string idMember or username
idBoardBackground path required string idBoardBackground

Responses

200 Success
400 Server rejection
DELETE /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
GET /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
operationId: Member_getCustomBoardBackgroundByIds

Parameters

Name In Required Type Description
idMember path required string idMember or username
idBoardBackground path required string idBoardBackground
fields query optional string all or a comma-separated list of: brightness, fullSizeUrl, scaled or tile

Responses

200 Success
400 Server rejection
GET /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_customBoardBackgrounds"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Custom Board Backgrounds\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
GET /members/{idMember}/customEmoji

This gets the list of all of the user’s uploaded emoji

operationId: Member_listCustomEmojiByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter query optional string One of: all or none

Responses

200 Success
400 Server rejection
GET /members/{idMember}/customEmoji
POST /members/{idMember}/customEmoji
operationId: Member_addCustomEmojiByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_customEmoji"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Custom Emoji\" to be added."
}

Responses

200 Success
400 Server rejection
POST /members/{idMember}/customEmoji
GET /members/{idMember}/customEmoji/{idCustomEmoji}
operationId: Member_getCustomEmojiByIds

Parameters

Name In Required Type Description
idMember path required string idMember or username
idCustomEmoji path required string idCustomEmoji
fields query optional string all or a comma-separated list of: name or url

Responses

200 Success
400 Server rejection
GET /members/{idMember}/customEmoji/{idCustomEmoji}
GET /members/{idMember}/customStickers

This gets a list of all of the user’s uploaded stickers

operationId: Member_getCustomStickersByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter query optional string One of: all or none

Responses

200 Success
400 Server rejection
GET /members/{idMember}/customStickers
POST /members/{idMember}/customStickers
operationId: Member_addCustomStickers

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_customStickers"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Custom Stickers\" to be added."
}

Responses

200 Success
400 Server rejection
POST /members/{idMember}/customStickers
DELETE /members/{idMember}/customStickers/{idCustomSticker}
operationId: Member_removeCustomStickerByIds

Parameters

Name In Required Type Description
idMember path required string idMember or username
idCustomSticker path required string idCustomSticker

Responses

200 Success
400 Server rejection
DELETE /members/{idMember}/customStickers/{idCustomSticker}
GET /members/{idMember}/customStickers/{idCustomSticker}
operationId: Member_getCustomStickerByIds

Parameters

Name In Required Type Description
idMember path required string idMember or username
idCustomSticker path required string idCustomSticker
fields query optional string all or a comma-separated list of: scaled or url

Responses

200 Success
400 Server rejection
GET /members/{idMember}/customStickers/{idCustomSticker}
GET /members/{idMember}/deltas
operationId: Member_getDeltasByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username
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 /members/{idMember}/deltas
PUT /members/{idMember}/fullName
operationId: Member_updateFullName

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_fullName"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Full Name\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_initials"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Initials\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /members/{idMember}/initials
GET /members/{idMember}/notifications

You can only read the notifications for the member associated with the supplied token

operationId: Member_getNotificationsByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username
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: addAdminToBoard, addAdminToOrganization, addedAttachmentToCard, addedMemberToCard, addedToBoard, addedToCard, addedToOrganization, cardDueSoon, changeCard, closeBoard, commentCard, createdCard, declinedInvitationToBoard, declinedInvitationToOrganization, invitedToBoard, invitedToOrganization, makeAdminOfBoard, makeAdminOfOrganization, memberJoinedTrello, mentionedOnCard, removedFromBoard, removedFromCard, removedFromOrganization, removedMemberFromCard, unconfirmedInvitedToBoard, unconfirmedInvitedToOrganization or updateCheckItemStateOnCard
read_filter query optional string One of: all, read or unread
fields query optional string all or a comma-separated list of: data, date, idMemberCreator, type or unread
limit query optional string a number from 1 to 1000
page query optional string a number from 0 to 100
before query optional string An id, or null
since query optional string An id, or null
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 /members/{idMember}/notifications
GET /members/{idMember}/notifications/{filter}
operationId: Member_getNotificationsByIdMemberByFilter

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter path required string filter

Responses

200 Success
400 Server rejection
GET /members/{idMember}/notifications/{filter}
POST /members/{idMember}/oneTimeMessagesDismissed
operationId: Member_addOneTimeMessagesDismissedByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_oneTimeMessagesDismissed"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members One Time Messages Dismissed\" to be added."
}

Responses

200 Success
400 Server rejection
POST /members/{idMember}/oneTimeMessagesDismissed
GET /members/{idMember}/organizations
operationId: Member_listOrganizationsById

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter query optional string One of: all, members, none or public
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
paid_account query optional string true or false

Responses

200 Success
400 Server rejection
GET /members/{idMember}/organizations
GET /members/{idMember}/organizations/{filter}
operationId: Member_getOrganizations

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter path required string filter

Responses

200 Success
400 Server rejection
GET /members/{idMember}/organizations/{filter}
GET /members/{idMember}/organizationsInvited
operationId: Member_listInvitedOrganizationsById

Parameters

Name In Required Type Description
idMember path required string idMember or username
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 /members/{idMember}/organizationsInvited
GET /members/{idMember}/organizationsInvited/{field}
operationId: Member_listOrganizationsInvitedByIdMemberByField

Parameters

Name In Required Type Description
idMember path required string idMember or username
field path required string field

Responses

200 Success
400 Server rejection
GET /members/{idMember}/organizationsInvited/{field}
PUT /members/{idMember}/prefs/colorBlind
operationId: Member_updatePrefsColorBlindByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_colorBlind"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Color Blind\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_locale"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Locale\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_minutesBetweenSummaries"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Minutes Between Summaries\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /members/{idMember}/prefs/minutesBetweenSummaries
GET /members/{idMember}/savedSearches
operationId: Member_getSavedSearchesByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username

Responses

200 Success
400 Server rejection
GET /members/{idMember}/savedSearches
POST /members/{idMember}/savedSearches
operationId: Member_createSavedSearch

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_savedSearches"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Saved Searches\" to be added."
}

Responses

200 Success
400 Server rejection
POST /members/{idMember}/savedSearches
DELETE /members/{idMember}/savedSearches/{idSavedSearch}
operationId: Member_removeSavedSearchByIds

Parameters

Name In Required Type Description
idMember path required string idMember or username
idSavedSearch path required string idSavedSearch

Responses

200 Success
400 Server rejection
DELETE /members/{idMember}/savedSearches/{idSavedSearch}
GET /members/{idMember}/savedSearches/{idSavedSearch}
operationId: Member_getSavedSearchByIds

Parameters

Name In Required Type Description
idMember path required string idMember or username
idSavedSearch path required string idSavedSearch

Responses

200 Success
400 Server rejection
GET /members/{idMember}/savedSearches/{idSavedSearch}
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_savedSearches"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Saved Searches\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_savedSearches_name"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Saved Searches Name\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_savedSearches_pos"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Saved Searches Pos\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_savedSearches_query"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Saved Searches Query\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /members/{idMember}/savedSearches/{idSavedSearch}/query
GET /members/{idMember}/tokens
operationId: Member_getTokensByIdMember

Parameters

Name In Required Type Description
idMember path required string idMember or username
filter query optional string One of: all or none

Responses

200 Success
400 Server rejection
GET /members/{idMember}/tokens
PUT /members/{idMember}/username
operationId: Member_updateUsernameById

Parameters

Name In Required Type Description
idMember path required string idMember or username

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/members_username"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Members Username\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /members/{idMember}/username
GET /members/{idMember}/{field}
operationId: Member_getByField

Parameters

Name In Required Type Description
idMember path required string idMember or username
field path required string field

Responses

200 Success
400 Server rejection
GET /members/{idMember}/{field}

Notification 19 endpoints

POST /notifications/all/read
operationId: Notification_markAllAsRead

Responses

200 Success
400 Server rejection
POST /notifications/all/read
GET /notifications/{idNotification}
operationId: Notification_getById

Parameters

Name In Required Type Description
idNotification path required string idNotification
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, type or unread
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
board query optional string true or false
board_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
list query optional string true or false
card query optional string true or false
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
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
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

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}
PUT /notifications/{idNotification}
operationId: Notification_updateByIdNotification

Parameters

Name In Required Type Description
idNotification path required string idNotification

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/notifications"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Notifications\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /notifications/{idNotification}
GET /notifications/{idNotification}/board
operationId: Notification_getBoardById

Parameters

Name In Required Type Description
idNotification path required string idNotification
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 /notifications/{idNotification}/board
GET /notifications/{idNotification}/board/{field}
operationId: Notification_getBoardByField

Parameters

Name In Required Type Description
idNotification path required string idNotification
field path required string field

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}/board/{field}
GET /notifications/{idNotification}/card
operationId: Notification_getCardById

Parameters

Name In Required Type Description
idNotification path required string idNotification
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 /notifications/{idNotification}/card
GET /notifications/{idNotification}/card/{field}
operationId: Notification_getCardByIdNotificationByField

Parameters

Name In Required Type Description
idNotification path required string idNotification
field path required string field

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}/card/{field}
GET /notifications/{idNotification}/display
operationId: Notification_getDisplayByIdNotification

Parameters

Name In Required Type Description
idNotification path required string idNotification

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}/display
GET /notifications/{idNotification}/entities
operationId: Notification_getEntitiesByIdNotification

Parameters

Name In Required Type Description
idNotification path required string idNotification

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}/entities
GET /notifications/{idNotification}/list
operationId: Notification_getListByIdNotification

Parameters

Name In Required Type Description
idNotification path required string idNotification
fields query optional string all or a comma-separated list of: closed, idBoard, name, pos or subscribed

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}/list
GET /notifications/{idNotification}/list/{field}
operationId: Notification_getListByIdNotificationByField

Parameters

Name In Required Type Description
idNotification path required string idNotification
field path required string field

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}/list/{field}
GET /notifications/{idNotification}/member
operationId: Notification_getMemberByNotification

Parameters

Name In Required Type Description
idNotification path required string idNotification
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 /notifications/{idNotification}/member
GET /notifications/{idNotification}/member/{field}
operationId: Notification_getMemberByIdField

Parameters

Name In Required Type Description
idNotification path required string idNotification
field path required string field

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}/member/{field}
GET /notifications/{idNotification}/memberCreator
operationId: Notification_getMemberCreatorById

Parameters

Name In Required Type Description
idNotification path required string idNotification
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 /notifications/{idNotification}/memberCreator
GET /notifications/{idNotification}/memberCreator/{field}
operationId: Notification_getMemberByIdNotificationByField

Parameters

Name In Required Type Description
idNotification path required string idNotification
field path required string field

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}/memberCreator/{field}
GET /notifications/{idNotification}/organization
operationId: Notification_getOrganizationByIdNotification

Parameters

Name In Required Type Description
idNotification path required string idNotification
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 /notifications/{idNotification}/organization
GET /notifications/{idNotification}/organization/{field}
operationId: Notification_getOrganizationByIdNotificationByField

Parameters

Name In Required Type Description
idNotification path required string idNotification
field path required string field

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}/organization/{field}
PUT /notifications/{idNotification}/unread
operationId: Notification_updateUnreadByIdNotification

Parameters

Name In Required Type Description
idNotification path required string idNotification

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/notifications_unread"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Notifications Unread\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /notifications/{idNotification}/unread
GET /notifications/{idNotification}/{field}
operationId: Notification_getByIdField

Parameters

Name In Required Type Description
idNotification path required string idNotification
field path required string field

Responses

200 Success
400 Server rejection
GET /notifications/{idNotification}/{field}

Organization 38 endpoints

POST /organizations
operationId: Organization_create

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organizations"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Organizations\" to be added."
}

Responses

200 Success
400 Server rejection
POST /organizations
DELETE /organizations/{idOrg}
operationId: Organization_removeByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name

Responses

200 Success
400 Server rejection
DELETE /organizations/{idOrg}
GET /organizations/{idOrg}
operationId: Organization_getByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
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
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
member_activity query optional string true or false ; works for premium organizations only.
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
boards query optional string all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned
board_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
board_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
board_actions_entities query optional string true or false
board_actions_display query optional string true or false
board_actions_format query optional string One of: count, list or minimal
board_actions_since query optional string A date, null or lastView
board_actions_limit query optional string a number from 0 to 1000
board_action_fields query optional string all or a comma-separated list of: data, date, idMemberCreator or type
board_lists query optional string One of: all, closed, none or open
paid_account query optional string true or false
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 /organizations/{idOrg}
PUT /organizations/{idOrg}
operationId: Organization_updateByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organizations"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Organizations\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /organizations/{idOrg}
GET /organizations/{idOrg}/actions
operationId: Organization_getActionsByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
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 /organizations/{idOrg}/actions
GET /organizations/{idOrg}/boards
operationId: Organization_getBoardsByOrgId

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
filter query optional string all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned
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
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_limit query optional string a number from 0 to 1000
actions_format query optional string One of: count, list or minimal
actions_since query optional string A date, null or lastView
action_fields query optional string all or a comma-separated list of: data, date, idMemberCreator or type
memberships query optional string all or a comma-separated list of: active, admin, deactivated, me or normal
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
lists query optional string One of: all, closed, none or open

Responses

200 Success
400 Server rejection
GET /organizations/{idOrg}/boards
GET /organizations/{idOrg}/boards/{filter}
operationId: Organization_getBoardsByIdOrgByFilter

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
filter path required string filter

Responses

200 Success
400 Server rejection
GET /organizations/{idOrg}/boards/{filter}
GET /organizations/{idOrg}/deltas
operationId: Organization_getOrganizationDeltas

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
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 /organizations/{idOrg}/deltas
PUT /organizations/{idOrg}/desc
operationId: Organization_updateDescriptionByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organizations_desc"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Organizations Desc\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organizations_displayName"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Organizations Display Name\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /organizations/{idOrg}/displayName
DELETE /organizations/{idOrg}/logo
operationId: Organization_removeLogoByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name

Responses

200 Success
400 Server rejection
DELETE /organizations/{idOrg}/logo
POST /organizations/{idOrg}/logo
operationId: Organization_uploadLogoByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organizations_logo"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Organizations Logo\" to be added."
}

Responses

200 Success
400 Server rejection
POST /organizations/{idOrg}/logo
GET /organizations/{idOrg}/members
operationId: Organization_getMembersByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
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 /organizations/{idOrg}/members
PUT /organizations/{idOrg}/members
operationId: Organization_updateMembersByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name

Request Body

{
  "$ref": "#/components/requestBodies/organizations_members"
}

Responses

200 Success
400 Server rejection
PUT /organizations/{idOrg}/members
GET /organizations/{idOrg}/members/{filter}
operationId: Organization_listMembersByIdOrgByFilter

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
filter path required string filter

Responses

200 Success
400 Server rejection
GET /organizations/{idOrg}/members/{filter}
DELETE /organizations/{idOrg}/members/{idMember}
operationId: Organization_removeMemberByIdOrgByIdMember

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
idMember path required string idMember

Responses

200 Success
400 Server rejection
DELETE /organizations/{idOrg}/members/{idMember}
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

{
  "$ref": "#/components/requestBodies/organizations_members"
}

Responses

200 Success
400 Server rejection
PUT /organizations/{idOrg}/members/{idMember}
DELETE /organizations/{idOrg}/members/{idMember}/all
operationId: Organization_removeMemberAll

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
idMember path required string idMember

Responses

200 Success
400 Server rejection
DELETE /organizations/{idOrg}/members/{idMember}/all
GET /organizations/{idOrg}/members/{idMember}/cards
operationId: Organization_listMembersCardsByIdOrgByIdMember

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
idMember path required string idMember
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
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
board query optional string true or false
board_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
list query optional string true or false
list_fields query optional string all or a comma-separated list of: closed, idBoard, name, pos or subscribed
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 /organizations/{idOrg}/members/{idMember}/cards
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organizations_members_deactivated"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Organizations Members Deactivated\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /organizations/{idOrg}/members/{idMember}/deactivated
GET /organizations/{idOrg}/membersInvited
operationId: Organization_getMembersInvitedByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
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 /organizations/{idOrg}/membersInvited
GET /organizations/{idOrg}/membersInvited/{field}
operationId: Organization_getMembersInvitedByIdOrgByField

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
field path required string field

Responses

200 Success
400 Server rejection
GET /organizations/{idOrg}/membersInvited/{field}
GET /organizations/{idOrg}/memberships
operationId: Organization_listMembershipsByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
filter query optional string all or a comma-separated list of: active, admin, deactivated, me or normal
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

Responses

200 Success
400 Server rejection
GET /organizations/{idOrg}/memberships
GET /organizations/{idOrg}/memberships/{idMembership}
operationId: Organization_getMembershipsByIdOrgByIdMembership

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
idMembership path required string idMembership
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

Responses

200 Success
400 Server rejection
GET /organizations/{idOrg}/memberships/{idMembership}
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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organizations_memberships"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Organizations Memberships\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organizations_name"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Organizations Name\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /organizations/{idOrg}/name
DELETE /organizations/{idOrg}/prefs/associatedDomain
operationId: Organization_deletePrefsAssociatedDomainByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name

Responses

200 Success
400 Server rejection
DELETE /organizations/{idOrg}/prefs/associatedDomain
PUT /organizations/{idOrg}/prefs/associatedDomain
operationId: Organization_updatePrefsAssociatedDomainByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_associatedDomain"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Associated Domain\" to be updated."
}

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

{
  "$ref": "#/components/requestBodies/prefs_boardVisibilityRestrict"
}

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

{
  "$ref": "#/components/requestBodies/prefs_boardVisibilityRestrict"
}

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

{
  "$ref": "#/components/requestBodies/prefs_boardVisibilityRestrict"
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_externalMembersDisabled"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs External Members Disabled\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_googleAppsVersion"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Google Apps Version\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /organizations/{idOrg}/prefs/googleAppsVersion
DELETE /organizations/{idOrg}/prefs/orgInviteRestrict
operationId: Organization_removeInviteRestrictByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
value query required string An email address with optional expansion tokens

Responses

200 Success
400 Server rejection
DELETE /organizations/{idOrg}/prefs/orgInviteRestrict
PUT /organizations/{idOrg}/prefs/orgInviteRestrict
operationId: Organization_updatePrefsOrgInviteRestrictByIdOrg

Parameters

Name In Required Type Description
idOrg path required string idOrg or name

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/prefs_orgInviteRestrict"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Prefs Org Invite Restrict\" to be updated."
}

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

{
  "$ref": "#/components/requestBodies/prefs_permissionLevel"
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organizations_website"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Organizations Website\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /organizations/{idOrg}/website
GET /organizations/{idOrg}/{field}
operationId: Organization_getByIdAndField

Parameters

Name In Required Type Description
idOrg path required string idOrg or name
field path required string field

Responses

200 Success
400 Server rejection
GET /organizations/{idOrg}/{field}

Session 4 endpoints

POST /sessions
operationId: Session_createAndUpdate

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/sessions"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Sessions\" to be added."
}

Responses

200 Success
400 Server rejection
POST /sessions
GET /sessions/socket

This is the route for WebSocket requests. See the socket API reference for a description of WebSocket usage.

operationId: Session_getSocketSessions

Responses

200 Success
400 Server rejection
GET /sessions/socket
PUT /sessions/{idSession}
operationId: Session_updateStatusByIdSession

Parameters

Name In Required Type Description
idSession path required string idSession

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/sessions"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Sessions\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/sessions_status"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Sessions Status\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /sessions/{idSession}/status

Token 10 endpoints

DELETE /tokens/{token}
operationId: Token_deleteByToken

Responses

200 Success
400 Server rejection
DELETE /tokens/{token}
GET /tokens/{token}
operationId: Token_getByToken

Parameters

Name In Required Type Description
fields query optional string all or a comma-separated list of: dateCreated, dateExpires, idMember, identifier or permissions
webhooks query optional string true or false

Responses

200 Success
400 Server rejection
GET /tokens/{token}
GET /tokens/{token}/member
operationId: Token_getMemberByToken

Parameters

Name In Required Type Description
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 /tokens/{token}/member
GET /tokens/{token}/member/{field}
operationId: Token_getMemberByField

Parameters

Name In Required Type Description
field path required string field

Responses

200 Success
400 Server rejection
GET /tokens/{token}/member/{field}
GET /tokens/{token}/webhooks
operationId: Token_getWebhooks

Responses

200 Success
400 Server rejection
GET /tokens/{token}/webhooks
POST /tokens/{token}/webhooks
operationId: Token_registerWebhook

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/tokens_webhooks"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Tokens Webhooks\" to be added."
}

Responses

200 Success
400 Server rejection
POST /tokens/{token}/webhooks
PUT /tokens/{token}/webhooks
operationId: Token_updateWebhooksByToken

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/tokens_webhooks"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Tokens Webhooks\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /tokens/{token}/webhooks
DELETE /tokens/{token}/webhooks/{idWebhook}
operationId: Token_removeByTokenByIdWebhook

Parameters

Name In Required Type Description
idWebhook path required string idWebhook

Responses

200 Success
400 Server rejection
DELETE /tokens/{token}/webhooks/{idWebhook}
GET /tokens/{token}/webhooks/{idWebhook}
operationId: Token_getWebhookById

Parameters

Name In Required Type Description
idWebhook path required string idWebhook

Responses

200 Success
400 Server rejection
GET /tokens/{token}/webhooks/{idWebhook}
GET /tokens/{token}/{field}
operationId: Token_getByTokenByField

Parameters

Name In Required Type Description
token path required string token
field path required string field

Responses

200 Success
400 Server rejection
GET /tokens/{token}/{field}

Type 1 endpoints

GET /types/{id}
operationId: Type_getById

Parameters

Name In Required Type Description
id path required string id

Responses

200 Success
400 Server rejection
GET /types/{id}

Webhook 9 endpoints

PUT /webhooks
operationId: Webhook_update

Request Body

{
  "$ref": "#/components/requestBodies/webhooks"
}

Responses

200 Success
400 Server rejection
PUT /webhooks
DELETE /webhooks/{idWebhook}
operationId: Webhook_removeById

Parameters

Name In Required Type Description
idWebhook path required string idWebhook

Responses

200 Success
400 Server rejection
DELETE /webhooks/{idWebhook}
GET /webhooks/{idWebhook}
operationId: Webhook_getById

Parameters

Name In Required Type Description
idWebhook path required string idWebhook

Responses

200 Success
400 Server rejection
GET /webhooks/{idWebhook}
PUT /webhooks/{idWebhook}
operationId: Webhook_updateByIdWebhook

Parameters

Name In Required Type Description
idWebhook path required string idWebhook

Request Body

{
  "$ref": "#/components/requestBodies/webhooks"
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/webhooks_active"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Webhooks Active\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/webhooks_callbackURL"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Webhooks Callback Url\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/webhooks_description"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Webhooks Description\" to be updated."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/webhooks_idModel"
      }
    }
  },
  "required": true,
  "description": "Attributes of \"Webhooks Id Model\" to be updated."
}

Responses

200 Success
400 Server rejection
PUT /webhooks/{idWebhook}/idModel
GET /webhooks/{idWebhook}/{field}
operationId: Webhook_getByIdField

Parameters

Name In Required Type Description
idWebhook path required string idWebhook
field path required string field

Responses

200 Success
400 Server rejection
GET /webhooks/{idWebhook}/{field}

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"
    }
  }
}
object labels_color 
{
  "xml": {
    "name": "label"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A valid label color or null"
    }
  }
}
object labels_name 
{
  "xml": {
    "name": "label"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object lists 
{
  "xml": {
    "name": "list"
  },
  "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"
    },
    "closed": {
      "type": "string",
      "description": " true or false"
    },
    "idBoard": {
      "type": "string",
      "description": "id of the board that the list should be added to"
    },
    "subscribed": {
      "type": "string",
      "description": " true or false"
    },
    "idListSource": {
      "type": "string",
      "description": "The id of the list to copy into a new list."
    }
  }
}
object lists_cards 
{
  "xml": {
    "name": "list"
  },
  "type": "object",
  "properties": {
    "due": {
      "type": "string",
      "description": "A date, or null"
    },
    "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"
    },
    "labels": {
      "type": "string",
      "description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
    },
    "idMembers": {
      "type": "string",
      "description": "A comma-separated list of objectIds, 24-character hex strings"
    }
  }
}
object lists_closed 
{
  "xml": {
    "name": "list"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object lists_idBoard 
{
  "xml": {
    "name": "list"
  },
  "type": "object",
  "properties": {
    "pos": {
      "type": "string",
      "description": "position of the list on the new board"
    },
    "value": {
      "type": "string",
      "description": "id of the board the list should be moved to"
    }
  }
}
object lists_moveAllCards 
{
  "xml": {
    "name": "list"
  },
  "type": "object",
  "properties": {
    "idBoard": {
      "type": "string",
      "description": "id of the board that the cards should be moved to"
    }
  }
}
object lists_name 
{
  "xml": {
    "name": "list"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object lists_pos 
{
  "xml": {
    "name": "list"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    }
  }
}
object lists_subscribed 
{
  "xml": {
    "name": "list"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object members 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "bio": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    },
    "fullName": {
      "type": "string",
      "description": "A string with a length of at least 1.  Cannot begin or end with a space."
    },
    "initials": {
      "type": "string",
      "description": "A string with a length from 1 to 4.  Cannot begin or end with a space"
    },
    "username": {
      "type": "string",
      "description": "A string with a length of at least 3.  Only lowercase letters, underscores, and numbers are allowed.  Must be unique."
    },
    "avatarSource": {
      "type": "string",
      "description": "One of: gravatar, none or upload"
    },
    "prefs/locale": {
      "type": "string",
      "description": "a string with a length from 0 to 255"
    },
    "prefs/colorBlind": {
      "type": "string",
      "description": " true or false"
    },
    "prefs/minutesBetweenSummaries": {
      "type": "string",
      "description": "-1 (disabled), 1 or 60"
    }
  }
}
object members_avatar 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "A file"
    }
  }
}
object members_avatarSource 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: gravatar, none or upload"
    }
  }
}
object members_bio 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object members_boardBackgrounds 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "A file"
    },
    "tile": {
      "type": "string",
      "description": " true or false"
    },
    "brightness": {
      "type": "string",
      "description": "One of: dark, light or unknown"
    }
  }
}
object members_boardStars 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "pos": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    },
    "idBoard": {
      "type": "string",
      "description": "The id of the board to star"
    }
  }
}
object members_boardStars_idBoard 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "An id"
    }
  }
}
object members_boardStars_pos 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    }
  }
}
object members_customBoardBackgrounds 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "A file"
    },
    "tile": {
      "type": "string",
      "description": " true or false"
    },
    "brightness": {
      "type": "string",
      "description": "One of: dark, light or unknown"
    }
  }
}
object members_customEmoji 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "A file"
    },
    "name": {
      "type": "string",
      "description": "a string with a length from 2 to 64"
    }
  }
}
object members_customStickers 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "A file"
    }
  }
}
object members_fullName 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A string with a length of at least 1.  Cannot begin or end with a space."
    }
  }
}
object members_initials 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A string with a length from 1 to 4.  Cannot begin or end with a space"
    }
  }
}
object members_oneTimeMessagesDismissed 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "Type of message dismissed"
    }
  }
}
object members_savedSearches 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "pos": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    },
    "name": {
      "type": "string",
      "description": "A non-empty string with at least one non-space character"
    },
    "query": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object members_savedSearches_name 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A non-empty string with at least one non-space character"
    }
  }
}
object members_savedSearches_pos 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A position. top , bottom , or a positive number."
    }
  }
}
object members_savedSearches_query 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 1 to 16384"
    }
  }
}
object members_username 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A string with a length of at least 3.  Only lowercase letters, underscores, and numbers are allowed.  Must be unique."
    }
  }
}
object myPrefs_emailPosition 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: bottom or top"
    }
  }
}
object myPrefs_idEmailList 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "An id"
    }
  }
}
object myPrefs_showListGuide 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object myPrefs_showSidebar 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object myPrefs_showSidebarActivity 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object myPrefs_showSidebarBoardActions 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object myPrefs_showSidebarMembers 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object notifications 
{
  "xml": {
    "name": "notification"
  },
  "type": "object",
  "properties": {
    "unread": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object notifications_unread 
{
  "xml": {
    "name": "notification"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object organizations 
{
  "xml": {
    "name": "organization"
  },
  "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 0 to 16384"
    },
    "website": {
      "type": "string",
      "description": "A URL starting with http:// or https:// or null"
    },
    "displayName": {
      "type": "string",
      "description": "A string with a length of at least 1.  Cannot begin or end with a space."
    },
    "prefs/permissionLevel": {
      "type": "string",
      "description": "One of: private or public"
    },
    "prefs/associatedDomain": {
      "type": "string",
      "description": "The google apps domain to link this org to."
    },
    "prefs/googleAppsVersion": {
      "type": "string",
      "description": "a number from 1 to 2"
    },
    "prefs/orgInviteRestrict": {
      "type": "string",
      "description": "An email address with optional expansion tokens"
    },
    "prefs/externalMembersDisabled": {
      "type": "string",
      "description": " true or false"
    },
    "prefs/boardVisibilityRestrict/org": {
      "type": "string",
      "description": "One of: admin, none or org"
    },
    "prefs/boardVisibilityRestrict/public": {
      "type": "string",
      "description": "One of: admin, none or org"
    },
    "prefs/boardVisibilityRestrict/private": {
      "type": "string",
      "description": "One of: admin, none or org"
    }
  }
}
object organizations_desc 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object organizations_displayName 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A string with a length of at least 1.  Cannot begin or end with a space."
    }
  }
}
object organizations_logo 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "A file"
    }
  }
}
object organizations_members 
{
  "xml": {
    "name": "organization"
  },
  "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 organizations_members_deactivated 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object organizations_memberships 
{
  "xml": {
    "name": "organization"
  },
  "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 organizations_name 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A string with a length of at least 3.  Only lowercase letters, underscores, and numbers are allowed.  Must be unique."
    }
  }
}
object organizations_website 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A URL starting with http:// or https:// or null"
    }
  }
}
object prefs_associatedDomain 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "The google apps domain to link this org to."
    }
  }
}
object prefs_background 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A standard background name, or the id of a custom background"
    }
  }
}
object prefs_boardVisibilityRestrict 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: admin, none or org"
    }
  }
}
object prefs_calendarFeedEnabled 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object prefs_cardAging 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: pirate or regular"
    }
  }
}
object prefs_cardCovers 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object prefs_colorBlind 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object prefs_comments 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: disabled, members, observers, org or public"
    }
  }
}
object prefs_externalMembersDisabled 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object prefs_googleAppsVersion 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a number from 1 to 2"
    }
  }
}
object prefs_invitations 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: admins or members"
    }
  }
}
object prefs_locale 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 255"
    }
  }
}
object prefs_minutesBetweenSummaries 
{
  "xml": {
    "name": "member"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "-1 (disabled), 1 or 60"
    }
  }
}
object prefs_orgInviteRestrict 
{
  "xml": {
    "name": "organization"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "An email address with optional expansion tokens"
    }
  }
}
object prefs_permissionLevel 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: private or public"
    }
  }
}
object prefs_selfJoin 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object prefs_voting 
{
  "xml": {
    "name": "board"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: disabled, members, observers, org or public"
    }
  }
}
object sessions 
{
  "xml": {
    "name": "session"
  },
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "One of: active, disconnected or idle"
    },
    "idBoard": {
      "type": "string",
      "description": "The id of the board you're viewing.  Boards with no viewers will not get updates about members' statuses."
    }
  }
}
object sessions_status 
{
  "xml": {
    "name": "session"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "One of: active, disconnected or idle"
    }
  }
}
object tokens_webhooks 
{
  "xml": {
    "name": "token"
  },
  "type": "object",
  "properties": {
    "idModel": {
      "type": "string",
      "description": "id of the model to be monitored"
    },
    "callbackURL": {
      "type": "string",
      "description": "A valid URL that is reachable with a HEAD request"
    },
    "description": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object webhooks 
{
  "xml": {
    "name": "webhook"
  },
  "type": "object",
  "properties": {
    "active": {
      "type": "string",
      "description": " true or false"
    },
    "idModel": {
      "type": "string",
      "description": "id of the model that should be hooked"
    },
    "callbackURL": {
      "type": "string",
      "description": "A valid URL that is reachable with a HEAD request"
    },
    "description": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object webhooks_active 
{
  "xml": {
    "name": "webhook"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": " true or false"
    }
  }
}
object webhooks_callbackURL 
{
  "xml": {
    "name": "webhook"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "A valid URL that is reachable with a HEAD request"
    }
  }
}
object webhooks_description 
{
  "xml": {
    "name": "webhook"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "a string with a length from 0 to 16384"
    }
  }
}
object webhooks_idModel 
{
  "xml": {
    "name": "webhook"
  },
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "id of the model to be monitored"
    }
  }
}