swagger: '2.0' schemes: - https host: trello.com basePath: /1 info: contact: name: Trello url: 'https://trello.com/home' description: |- This document describes the REST API of Trello as published by Trello.com. - Official Documentation - The HTML pages that were scraped in order to generate this specification. license: name: 'Trello : Terms of Service' url: 'https://trello.com/legal' termsOfService: 'https://trello.com/legal' title: Trello version: '1.0' externalDocs: url: 'https://developers.trello.com' securityDefinitions: api_key: in: query name: key type: apiKey api_token: in: query name: token type: apiKey tags: - description: 'https://trello.com/docs/api/action/index.html' name: action - description: 'https://trello.com/docs/api/batch/index.html' name: batch - description: 'https://trello.com/docs/api/board/index.html' name: board - description: 'https://trello.com/docs/api/card/index.html' name: card - description: 'https://trello.com/docs/api/checklist/index.html' name: checklist - description: 'https://trello.com/docs/api/label/index.html' name: label - description: 'https://trello.com/docs/api/list/index.html' name: list - description: 'https://trello.com/docs/api/member/index.html' name: member - description: 'https://trello.com/docs/api/notification/index.html' name: notification - description: 'https://trello.com/docs/api/organization/index.html' name: organization - description: 'https://trello.com/docs/api/search/index.html' name: search - description: 'https://trello.com/docs/api/session/index.html' name: session - description: 'https://trello.com/docs/api/token/index.html' name: token - description: 'https://trello.com/docs/api/type/index.html' name: type - description: 'https://trello.com/docs/api/webhook/index.html' name: webhook paths: '/actions/{idAction}': delete: operationId: deleteActionsByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteActionsByIdAction() tags: - action get: operationId: getActionsByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - description: ' true or false' in: query name: display required: false type: string - description: ' true or false' in: query name: entities required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: fields required: false type: string - description: ' true or false' in: query name: member required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: memberCreator required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberCreator_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsByIdAction() tags: - action put: operationId: updateActionsByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - description: Attributes of "Actions" to be updated. in: body name: body required: true schema: $ref: '#/definitions/actions' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateActionsByIdAction() tags: - action '/actions/{idAction}/board': get: operationId: getActionsBoardByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsBoardByIdAction() tags: - action '/actions/{idAction}/board/{field}': get: operationId: getActionsBoardByIdActionByField parameters: - description: idAction in: path name: idAction required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsBoardByIdActionByField() tags: - action '/actions/{idAction}/card': get: operationId: getActionsCardByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsCardByIdAction() tags: - action '/actions/{idAction}/card/{field}': get: operationId: getActionsCardByIdActionByField parameters: - description: idAction in: path name: idAction required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsCardByIdActionByField() tags: - action '/actions/{idAction}/display': get: operationId: getActionsDisplayByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsDisplayByIdAction() tags: - action '/actions/{idAction}/entities': get: operationId: getActionsEntitiesByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsEntitiesByIdAction() tags: - action '/actions/{idAction}/list': get: operationId: getActionsListByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - default: all description: 'all or a comma-separated list of: closed, idBoard, name, pos or subscribed' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsListByIdAction() tags: - action '/actions/{idAction}/list/{field}': get: operationId: getActionsListByIdActionByField parameters: - description: idAction in: path name: idAction required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsListByIdActionByField() tags: - action '/actions/{idAction}/member': get: operationId: getActionsMemberByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsMemberByIdAction() tags: - action '/actions/{idAction}/member/{field}': get: operationId: getActionsMemberByIdActionByField parameters: - description: idAction in: path name: idAction required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsMemberByIdActionByField() tags: - action '/actions/{idAction}/memberCreator': get: operationId: getActionsMemberCreatorByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsMemberCreatorByIdAction() tags: - action '/actions/{idAction}/memberCreator/{field}': get: operationId: getActionsMemberCreatorByIdActionByField parameters: - description: idAction in: path name: idAction required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsMemberCreatorByIdActionByField() tags: - action '/actions/{idAction}/organization': get: operationId: getActionsOrganizationByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - default: all description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsOrganizationByIdAction() tags: - action '/actions/{idAction}/organization/{field}': get: operationId: getActionsOrganizationByIdActionByField parameters: - description: idAction in: path name: idAction required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getActionsOrganizationByIdActionByField() tags: - action '/actions/{idAction}/text': put: operationId: updateActionsTextByIdAction parameters: - description: idAction in: path name: idAction required: true type: string - description: Attributes of "Actions Text" to be updated. in: body name: body required: true schema: $ref: '#/definitions/actions_text' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateActionsTextByIdAction() tags: - action '/actions/{idAction}/{field}': get: operationId: getActionsByIdActionByField parameters: - description: idAction in: path name: idAction required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getActionsByIdActionByField() tags: - action /batch: get: operationId: getBatch parameters: - description: 'list of API v1 GET routes, not including the version prefix' in: query name: urls required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getBatch() tags: - batch /boards: post: operationId: addBoards parameters: - description: Attributes of "Boards" to be added. in: body name: body required: true schema: $ref: '#/definitions/boards' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addBoards() tags: - board '/boards/{idBoard}': get: operationId: getBoardsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: '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' in: query name: actions required: false type: string - description: ' true or false' in: query name: actions_entities required: false type: string - description: ' true or false' in: query name: actions_display required: false type: string - default: list description: 'One of: count, list or minimal' in: query name: actions_format required: false type: string - description: 'A date, null or lastView' in: query name: actions_since required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: actions_limit required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: action_fields required: false type: string - description: ' true or false' in: query name: action_member required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: action_member_fields required: false type: string - description: ' true or false' in: query name: action_memberCreator required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: action_memberCreator_fields required: false type: string - default: none description: 'One of: all, closed, none, open or visible' in: query name: cards required: false type: string - default: all description: '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' in: query name: card_fields required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: card_attachments required: false type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: card_attachment_fields required: false type: string - default: none description: 'One of: all or none' in: query name: card_checklists required: false type: string - description: ' true or false' in: query name: card_stickers required: false type: string - default: none description: 'One of: mine or none' in: query name: boardStars required: false type: string - default: none description: 'One of: all or none' in: query name: labels required: false type: string - default: all description: 'all or a comma-separated list of: color, idBoard, name or uses' in: query name: label_fields required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: labels_limit required: false type: string - default: none description: 'One of: all, closed, none or open' in: query name: lists required: false type: string - default: all description: 'all or a comma-separated list of: closed, idBoard, name, pos or subscribed' in: query name: list_fields required: false type: string - default: none description: 'all or a comma-separated list of: active, admin, deactivated, me or normal' in: query name: memberships required: false type: string - description: ' true or false' in: query name: memberships_member required: false type: string - default: fullName and username description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberships_member_fields required: false type: string - default: none description: 'One of: admins, all, none, normal or owners' in: query name: members required: false type: string - default: 'avatarHash, initials, fullName, username and confirmed' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - default: none description: 'One of: admins, all, none, normal or owners' in: query name: membersInvited required: false type: string - default: 'avatarHash, initials, fullName and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: membersInvited_fields required: false type: string - default: none description: 'One of: all or none' in: query name: checklists required: false type: string - default: all description: 'all or a comma-separated list of: idBoard, idCard, name or pos' in: query name: checklist_fields required: false type: string - description: ' true or false' in: query name: organization required: false type: string - default: name and displayName description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: organization_fields required: false type: string - default: none description: 'all or a comma-separated list of: active, admin, deactivated, me or normal' in: query name: organization_memberships required: false type: string - description: ' true or false' in: query name: myPrefs required: false type: string - default: 'name, desc, descData, closed, idOrganization, pinned, url, shortUrl, prefs and labelNames' description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsByIdBoard() tags: - board put: operationId: updateBoardsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards" to be updated. in: body name: body required: true schema: $ref: '#/definitions/boards' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsByIdBoard() tags: - board '/boards/{idBoard}/actions': get: operationId: getBoardsActionsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: ' true or false' in: query name: entities required: false type: string - description: ' true or false' in: query name: display required: false type: string - default: all description: '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' in: query name: filter required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: fields required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: limit required: false type: string - default: list description: 'One of: count, list or minimal' in: query name: format required: false type: string - description: 'A date, null or lastView' in: query name: since required: false type: string - description: 'A date, or null' in: query name: before required: false type: string - default: '0' description: Page * limit must be less than 1000 in: query name: page required: false type: string - description: Only return actions related to these model ids in: query name: idModels required: false type: string - description: ' true or false' in: query name: member required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: memberCreator required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberCreator_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsActionsByIdBoard() tags: - board '/boards/{idBoard}/boardStars': get: operationId: getBoardsBoardStarsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - default: mine description: 'One of: mine or none' in: query name: filter required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsBoardStarsByIdBoard() tags: - board '/boards/{idBoard}/calendarKey/generate': post: operationId: addBoardsCalendarKeyGenerateByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addBoardsCalendarKeyGenerateByIdBoard() tags: - board '/boards/{idBoard}/cards': get: operationId: getBoardsCardsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: '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' in: query name: actions required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: attachments required: false type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: attachment_fields required: false type: string - description: ' true or false' in: query name: stickers required: false type: string - description: ' true or false' in: query name: members required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: checkItemStates required: false type: string - default: none description: 'One of: all or none' in: query name: checklists required: false type: string - description: a number from 1 to 1000 in: query name: limit required: false type: string - description: 'A date, or null' in: query name: since required: false type: string - description: 'A date, or null' in: query name: before required: false type: string - default: visible description: 'One of: all, closed, none, open or visible' in: query name: filter required: false type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsCardsByIdBoard() tags: - board '/boards/{idBoard}/cards/{filter}': get: operationId: getBoardsCardsByIdBoardByFilter parameters: - description: board_id in: path name: idBoard required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getBoardsCardsByIdBoardByFilter() tags: - board '/boards/{idBoard}/cards/{idCard}': get: operationId: getBoardsCardsByIdBoardByIdCard parameters: - description: board_id in: path name: idBoard required: true type: string - description: idCard in: path name: idCard required: true type: string - description: A boolean value or "cover" for only card cover attachments in: query name: attachments required: false type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: attachment_fields required: false type: string - description: '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' in: query name: actions required: false type: string - description: ' true or false' in: query name: actions_entities required: false type: string - description: ' true or false' in: query name: actions_display required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: actions_limit required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: action_fields required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: action_memberCreator_fields required: false type: string - description: ' true or false' in: query name: members required: false type: string - default: 'avatarHash, initials, fullName and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: checkItemStates required: false type: string - default: all description: 'all or a comma-separated list of: idCheckItem or state' in: query name: checkItemState_fields required: false type: string - description: ' true or false' in: query name: labels required: false type: string - default: none description: 'One of: all or none' in: query name: checklists required: false type: string - default: all description: 'all or a comma-separated list of: idBoard, idCard, name or pos' in: query name: checklist_fields required: false type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsCardsByIdBoardByIdCard() tags: - board '/boards/{idBoard}/checklists': get: operationId: getBoardsChecklistsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - default: none description: 'One of: all, closed, none, open or visible' in: query name: cards required: false type: string - default: all description: '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' in: query name: card_fields required: false type: string - default: all description: 'One of: all or none' in: query name: checkItems required: false type: string - default: 'name, nameData, pos and state' description: 'all or a comma-separated list of: name, nameData, pos, state or type' in: query name: checkItem_fields required: false type: string - default: all description: 'One of: all or none' in: query name: filter required: false type: string - default: all description: 'all or a comma-separated list of: idBoard, idCard, name or pos' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsChecklistsByIdBoard() tags: - board post: operationId: addBoardsChecklistsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards Checklists" to be added. in: body name: body required: true schema: $ref: '#/definitions/boards_checklists' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addBoardsChecklistsByIdBoard() tags: - board '/boards/{idBoard}/closed': put: operationId: updateBoardsClosedByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards Closed" to be updated. in: body name: body required: true schema: $ref: '#/definitions/boards_closed' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsClosedByIdBoard() tags: - board '/boards/{idBoard}/deltas': get: operationId: getBoardsDeltasByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: A valid tag for subscribing in: query name: tags required: true type: string - description: a number from -1 to Infinity in: query name: ixLastUpdate required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsDeltasByIdBoard() tags: - board '/boards/{idBoard}/desc': put: operationId: updateBoardsDescByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards Desc" to be updated. in: body name: body required: true schema: $ref: '#/definitions/boards_desc' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsDescByIdBoard() tags: - board '/boards/{idBoard}/emailKey/generate': post: operationId: addBoardsEmailKeyGenerateByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addBoardsEmailKeyGenerateByIdBoard() tags: - board '/boards/{idBoard}/idOrganization': put: operationId: updateBoardsIdOrganizationByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards Id Organization" to be updated. in: body name: body required: true schema: $ref: '#/definitions/boards_idOrganization' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsIdOrganizationByIdBoard() tags: - board '/boards/{idBoard}/labelNames/blue': put: operationId: updateBoardsLabelNamesBlueByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Label Names Blue" to be updated. in: body name: body required: true schema: $ref: '#/definitions/labelNames_blue' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsLabelNamesBlueByIdBoard() tags: - board '/boards/{idBoard}/labelNames/green': put: operationId: updateBoardsLabelNamesGreenByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Label Names Green" to be updated. in: body name: body required: true schema: $ref: '#/definitions/labelNames_green' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsLabelNamesGreenByIdBoard() tags: - board '/boards/{idBoard}/labelNames/orange': put: operationId: updateBoardsLabelNamesOrangeByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Label Names Orange" to be updated. in: body name: body required: true schema: $ref: '#/definitions/labelNames_orange' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsLabelNamesOrangeByIdBoard() tags: - board '/boards/{idBoard}/labelNames/purple': put: operationId: updateBoardsLabelNamesPurpleByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Label Names Purple" to be updated. in: body name: body required: true schema: $ref: '#/definitions/labelNames_purple' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsLabelNamesPurpleByIdBoard() tags: - board '/boards/{idBoard}/labelNames/red': put: operationId: updateBoardsLabelNamesRedByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Label Names Red" to be updated. in: body name: body required: true schema: $ref: '#/definitions/labelNames_red' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsLabelNamesRedByIdBoard() tags: - board '/boards/{idBoard}/labelNames/yellow': put: operationId: updateBoardsLabelNamesYellowByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Label Names Yellow" to be updated. in: body name: body required: true schema: $ref: '#/definitions/labelNames_yellow' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsLabelNamesYellowByIdBoard() tags: - board '/boards/{idBoard}/labels': get: operationId: getBoardsLabelsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - default: all description: 'all or a comma-separated list of: color, idBoard, name or uses' in: query name: fields required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: limit required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsLabelsByIdBoard() tags: - board post: operationId: addBoardsLabelsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards Labels" to be added. in: body name: body required: true schema: $ref: '#/definitions/boards_labels' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addBoardsLabelsByIdBoard() tags: - board '/boards/{idBoard}/labels/{idLabel}': get: operationId: getBoardsLabelsByIdBoardByIdLabel parameters: - description: board_id in: path name: idBoard required: true type: string - description: idLabel in: path name: idLabel required: true type: string - default: all description: 'all or a comma-separated list of: color, idBoard, name or uses' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsLabelsByIdBoardByIdLabel() tags: - board '/boards/{idBoard}/lists': get: operationId: getBoardsListsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - default: none description: 'One of: all, closed, none, open or visible' in: query name: cards required: false type: string - default: all description: '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' in: query name: card_fields required: false type: string - default: open description: 'One of: all, closed, none or open' in: query name: filter required: false type: string - default: all description: 'all or a comma-separated list of: closed, idBoard, name, pos or subscribed' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsListsByIdBoard() tags: - board post: operationId: addBoardsListsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards Lists" to be added. in: body name: body required: true schema: $ref: '#/definitions/boards_lists' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addBoardsListsByIdBoard() tags: - board '/boards/{idBoard}/lists/{filter}': get: operationId: getBoardsListsByIdBoardByFilter parameters: - description: board_id in: path name: idBoard required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getBoardsListsByIdBoardByFilter() tags: - board '/boards/{idBoard}/markAsViewed': post: operationId: addBoardsMarkAsViewedByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addBoardsMarkAsViewedByIdBoard() tags: - board '/boards/{idBoard}/members': get: operationId: getBoardsMembersByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - default: all description: 'One of: admins, all, none, normal or owners' in: query name: filter required: false type: string - default: fullName and username description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: fields required: false type: string - description: true or false ; works for premium organizations only. in: query name: activity required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsMembersByIdBoard() tags: - board put: operationId: updateBoardsMembersByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards Members" to be updated. in: body name: body required: true schema: $ref: '#/definitions/boards_members' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsMembersByIdBoard() tags: - board '/boards/{idBoard}/members/{filter}': get: operationId: getBoardsMembersByIdBoardByFilter parameters: - description: board_id in: path name: idBoard required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getBoardsMembersByIdBoardByFilter() tags: - board '/boards/{idBoard}/members/{idMember}': delete: operationId: deleteBoardsMembersByIdBoardByIdMember parameters: - description: board_id in: path name: idBoard required: true type: string - description: idMember in: path name: idMember required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteBoardsMembersByIdBoardByIdMember() tags: - board put: operationId: updateBoardsMembersByIdBoardByIdMember parameters: - description: board_id in: path name: idBoard required: true type: string - description: idMember in: path name: idMember required: true type: string - description: Attributes of "Boards Members" to be updated. in: body name: body required: true schema: $ref: '#/definitions/boards_members' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsMembersByIdBoardByIdMember() tags: - board '/boards/{idBoard}/members/{idMember}/cards': get: operationId: getBoardsMembersCardsByIdBoardByIdMember parameters: - description: board_id in: path name: idBoard required: true type: string - description: idMember in: path name: idMember required: true type: string - description: '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' in: query name: actions required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: attachments required: false type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: attachment_fields required: false type: string - description: ' true or false' in: query name: members required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: checkItemStates required: false type: string - default: none description: 'One of: all or none' in: query name: checklists required: false type: string - description: ' true or false' in: query name: board required: false type: string - default: 'name, desc, closed, idOrganization, pinned, url and prefs' description: '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' in: query name: board_fields required: false type: string - description: ' true or false' in: query name: list required: false type: string - default: all description: 'all or a comma-separated list of: closed, idBoard, name, pos or subscribed' in: query name: list_fields required: false type: string - default: visible description: 'One of: all, closed, none, open or visible' in: query name: filter required: false type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsMembersCardsByIdBoardByIdMember() tags: - board '/boards/{idBoard}/membersInvited': get: operationId: getBoardsMembersInvitedByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsMembersInvitedByIdBoard() tags: - board '/boards/{idBoard}/membersInvited/{field}': get: operationId: getBoardsMembersInvitedByIdBoardByField parameters: - description: board_id in: path name: idBoard required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsMembersInvitedByIdBoardByField() tags: - board '/boards/{idBoard}/memberships': get: operationId: getBoardsMembershipsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - default: all description: 'all or a comma-separated list of: active, admin, deactivated, me or normal' in: query name: filter required: false type: string - description: ' true or false' in: query name: member required: false type: string - default: fullName and username description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsMembershipsByIdBoard() tags: - board '/boards/{idBoard}/memberships/{idMembership}': get: operationId: getBoardsMembershipsByIdBoardByIdMembership parameters: - description: board_id in: path name: idBoard required: true type: string - description: idMembership in: path name: idMembership required: true type: string - description: ' true or false' in: query name: member required: false type: string - default: fullName and username description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsMembershipsByIdBoardByIdMembership() tags: - board put: operationId: updateBoardsMembershipsByIdBoardByIdMembership parameters: - description: board_id in: path name: idBoard required: true type: string - description: idMembership in: path name: idMembership required: true type: string - description: Attributes of "Boards Memberships" to be updated. in: body name: body required: true schema: $ref: '#/definitions/boards_memberships' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsMembershipsByIdBoardByIdMembership() tags: - board '/boards/{idBoard}/myPrefs': get: operationId: getBoardsMyPrefsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsMyPrefsByIdBoard() tags: - board '/boards/{idBoard}/myPrefs/emailPosition': put: operationId: updateBoardsMyPrefsEmailPositionByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "My Prefs Email Position" to be updated. in: body name: body required: true schema: $ref: '#/definitions/myPrefs_emailPosition' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsMyPrefsEmailPositionByIdBoard() tags: - board '/boards/{idBoard}/myPrefs/idEmailList': put: operationId: updateBoardsMyPrefsIdEmailListByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "My Prefs Id Email List" to be updated. in: body name: body required: true schema: $ref: '#/definitions/myPrefs_idEmailList' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsMyPrefsIdEmailListByIdBoard() tags: - board '/boards/{idBoard}/myPrefs/showListGuide': put: operationId: updateBoardsMyPrefsShowListGuideByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "My Prefs Show List Guide" to be updated. in: body name: body required: true schema: $ref: '#/definitions/myPrefs_showListGuide' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsMyPrefsShowListGuideByIdBoard() tags: - board '/boards/{idBoard}/myPrefs/showSidebar': put: operationId: updateBoardsMyPrefsShowSidebarByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "My Prefs Show Sidebar" to be updated. in: body name: body required: true schema: $ref: '#/definitions/myPrefs_showSidebar' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsMyPrefsShowSidebarByIdBoard() tags: - board '/boards/{idBoard}/myPrefs/showSidebarActivity': put: operationId: updateBoardsMyPrefsShowSidebarActivityByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "My Prefs Show Sidebar Activity" to be updated. in: body name: body required: true schema: $ref: '#/definitions/myPrefs_showSidebarActivity' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsMyPrefsShowSidebarActivityByIdBoard() tags: - board '/boards/{idBoard}/myPrefs/showSidebarBoardActions': put: operationId: updateBoardsMyPrefsShowSidebarBoardActionsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "My Prefs Show Sidebar Board Actions" to be updated. in: body name: body required: true schema: $ref: '#/definitions/myPrefs_showSidebarBoardActions' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsMyPrefsShowSidebarBoardActionsByIdBoard() tags: - board '/boards/{idBoard}/myPrefs/showSidebarMembers': put: operationId: updateBoardsMyPrefsShowSidebarMembersByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "My Prefs Show Sidebar Members" to be updated. in: body name: body required: true schema: $ref: '#/definitions/myPrefs_showSidebarMembers' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsMyPrefsShowSidebarMembersByIdBoard() tags: - board '/boards/{idBoard}/name': put: operationId: updateBoardsNameByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards Name" to be updated. in: body name: body required: true schema: $ref: '#/definitions/boards_name' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsNameByIdBoard() tags: - board '/boards/{idBoard}/organization': get: operationId: getBoardsOrganizationByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - default: all description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsOrganizationByIdBoard() tags: - board '/boards/{idBoard}/organization/{field}': get: operationId: getBoardsOrganizationByIdBoardByField parameters: - description: board_id in: path name: idBoard required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getBoardsOrganizationByIdBoardByField() tags: - board '/boards/{idBoard}/powerUps': post: operationId: addBoardsPowerUpsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards Power Ups" to be added. in: body name: body required: true schema: $ref: '#/definitions/boards_powerUps' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addBoardsPowerUpsByIdBoard() tags: - board '/boards/{idBoard}/powerUps/{powerUp}': delete: operationId: deleteBoardsPowerUpsByIdBoardByPowerUp parameters: - description: board_id in: path name: idBoard required: true type: string - description: powerUp in: path name: powerUp required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteBoardsPowerUpsByIdBoardByPowerUp() tags: - board '/boards/{idBoard}/prefs/background': put: operationId: updateBoardsPrefsBackgroundByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Prefs Background" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_background' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsPrefsBackgroundByIdBoard() tags: - board '/boards/{idBoard}/prefs/calendarFeedEnabled': put: operationId: updateBoardsPrefsCalendarFeedEnabledByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Prefs Calendar Feed Enabled" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_calendarFeedEnabled' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsPrefsCalendarFeedEnabledByIdBoard() tags: - board '/boards/{idBoard}/prefs/cardAging': put: operationId: updateBoardsPrefsCardAgingByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Prefs Card Aging" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_cardAging' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsPrefsCardAgingByIdBoard() tags: - board '/boards/{idBoard}/prefs/cardCovers': put: operationId: updateBoardsPrefsCardCoversByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Prefs Card Covers" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_cardCovers' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsPrefsCardCoversByIdBoard() tags: - board '/boards/{idBoard}/prefs/comments': put: operationId: updateBoardsPrefsCommentsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Prefs Comments" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_comments' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsPrefsCommentsByIdBoard() tags: - board '/boards/{idBoard}/prefs/invitations': put: operationId: updateBoardsPrefsInvitationsByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Prefs Invitations" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_invitations' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsPrefsInvitationsByIdBoard() tags: - board '/boards/{idBoard}/prefs/permissionLevel': put: operationId: updateBoardsPrefsPermissionLevelByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Prefs Permission Level" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_permissionLevel' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsPrefsPermissionLevelByIdBoard() tags: - board '/boards/{idBoard}/prefs/selfJoin': put: operationId: updateBoardsPrefsSelfJoinByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Prefs Self Join" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_selfJoin' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsPrefsSelfJoinByIdBoard() tags: - board '/boards/{idBoard}/prefs/voting': put: operationId: updateBoardsPrefsVotingByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Prefs Voting" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_voting' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsPrefsVotingByIdBoard() tags: - board '/boards/{idBoard}/subscribed': put: operationId: updateBoardsSubscribedByIdBoard parameters: - description: board_id in: path name: idBoard required: true type: string - description: Attributes of "Boards Subscribed" to be updated. in: body name: body required: true schema: $ref: '#/definitions/boards_subscribed' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateBoardsSubscribedByIdBoard() tags: - board '/boards/{idBoard}/{field}': get: operationId: getBoardsByIdBoardByField parameters: - description: board_id in: path name: idBoard required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getBoardsByIdBoardByField() tags: - board /cards: post: operationId: addCards parameters: - description: Attributes of "Cards" to be added. in: body name: body required: true schema: $ref: '#/definitions/cards' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCards() tags: - card '/cards/{idCard}': delete: operationId: deleteCardsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteCardsByIdCard() tags: - card get: operationId: getCardsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: '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' in: query name: actions required: false type: string - description: ' true or false' in: query name: actions_entities required: false type: string - description: ' true or false' in: query name: actions_display required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: actions_limit required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: action_fields required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: action_memberCreator_fields required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: attachments required: false type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: attachment_fields required: false type: string - description: ' true or false' in: query name: members required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: membersVoted required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberVoted_fields required: false type: string - description: ' true or false' in: query name: checkItemStates required: false type: string - default: all description: 'all or a comma-separated list of: idCheckItem or state' in: query name: checkItemState_fields required: false type: string - default: none description: 'One of: all or none' in: query name: checklists required: false type: string - default: all description: 'all or a comma-separated list of: idBoard, idCard, name or pos' in: query name: checklist_fields required: false type: string - description: ' true or false' in: query name: board required: false type: string - default: 'name, desc, descData, closed, idOrganization, pinned, url and prefs' description: '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' in: query name: board_fields required: false type: string - description: ' true or false' in: query name: list required: false type: string - default: all description: 'all or a comma-separated list of: closed, idBoard, name, pos or subscribed' in: query name: list_fields required: false type: string - description: ' true or false' in: query name: stickers required: false type: string - default: all description: 'all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex' in: query name: sticker_fields required: false type: string - default: 'badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idBoard, idChecklists, idLabels, idList, idMembers, idShort, idAttachmentCover, manualCoverAttachment, labels, name, pos, shortUrl and url' description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsByIdCard() tags: - card put: operationId: updateCardsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsByIdCard() tags: - card '/cards/{idCard}/actions': get: operationId: getCardsActionsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: ' true or false' in: query name: entities required: false type: string - description: ' true or false' in: query name: display required: false type: string - default: 'commentCard and updateCard:idList' description: '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' in: query name: filter required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: fields required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: limit required: false type: string - default: list description: 'One of: count, list or minimal' in: query name: format required: false type: string - description: 'A date, null or lastView' in: query name: since required: false type: string - description: 'A date, or null' in: query name: before required: false type: string - default: '0' description: Page * limit must be less than 1000 in: query name: page required: false type: string - description: Only return actions related to these model ids in: query name: idModels required: false type: string - description: ' true or false' in: query name: member required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: memberCreator required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberCreator_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsActionsByIdCard() tags: - card '/cards/{idCard}/actions/comments': post: operationId: addCardsActionsCommentsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Actions Comments" to be added. in: body name: body required: true schema: $ref: '#/definitions/actions_comments' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsActionsCommentsByIdCard() tags: - card '/cards/{idCard}/actions/{idAction}/comments': delete: description: 'This can only be done by the original author of the comment, or someone with higher permissions than the original author.' operationId: deleteCardsActionsCommentsByIdCardByIdAction parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idAction in: path name: idAction required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteCardsActionsCommentsByIdCardByIdAction() tags: - card put: description: This can only be done by the original author of the comment. operationId: updateCardsActionsCommentsByIdCardByIdAction parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idAction in: path name: idAction required: true type: string - description: Attributes of "Cards Actions Comments" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_actions_comments' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsActionsCommentsByIdCardByIdAction() tags: - card '/cards/{idCard}/attachments': get: operationId: getCardsAttachmentsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: fields required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: filter required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsAttachmentsByIdCard() tags: - card post: operationId: addCardsAttachmentsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Attachments" to be added. in: body name: body required: true schema: $ref: '#/definitions/cards_attachments' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsAttachmentsByIdCard() tags: - card '/cards/{idCard}/attachments/{idAttachment}': delete: operationId: deleteCardsAttachmentsByIdCardByIdAttachment parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idAttachment in: path name: idAttachment required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteCardsAttachmentsByIdCardByIdAttachment() tags: - card get: operationId: getCardsAttachmentsByIdCardByIdAttachment parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idAttachment in: path name: idAttachment required: true type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsAttachmentsByIdCardByIdAttachment() tags: - card '/cards/{idCard}/board': get: operationId: getCardsBoardByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsBoardByIdCard() tags: - card '/cards/{idCard}/board/{field}': get: operationId: getCardsBoardByIdCardByField parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsBoardByIdCardByField() tags: - card '/cards/{idCard}/checkItemStates': get: operationId: getCardsCheckItemStatesByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - default: all description: 'all or a comma-separated list of: idCheckItem or state' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsCheckItemStatesByIdCard() tags: - card '/cards/{idCard}/checklist/{idChecklistCurrent}/checkItem/{idCheckItem}': put: operationId: updateCardsChecklistCheckItemByIdCardByIdChecklistCurrentByIdCheckItem parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idChecklistCurrent in: path name: idChecklistCurrent required: true type: string - description: idCheckItem in: path name: idCheckItem required: true type: string - description: Attributes of "Cards Checklist Id Checklist Current Check Item" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_checklist_idChecklistCurrent_checkItem' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsChecklistCheckItemByIdCardByIdChecklistCurrentByIdCheckItem() tags: - card '/cards/{idCard}/checklist/{idChecklist}/checkItem': post: operationId: addCardsChecklistCheckItemByIdCardByIdChecklist parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idChecklist in: path name: idChecklist required: true type: string - description: Attributes of "Cards Checklist Check Item" to be added. in: body name: body required: true schema: $ref: '#/definitions/cards_checklist_checkItem' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsChecklistCheckItemByIdCardByIdChecklist() tags: - card '/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}': delete: operationId: deleteCardsChecklistCheckItemByIdCardByIdChecklistByIdCheckItem parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idChecklist in: path name: idChecklist required: true type: string - description: idCheckItem in: path name: idCheckItem required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteCardsChecklistCheckItemByIdCardByIdChecklistByIdCheckItem() tags: - card '/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/convertToCard': post: operationId: addCardsChecklistCheckItemConvertToCardByIdCardByIdChecklistByIdCheckItem parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idChecklist in: path name: idChecklist required: true type: string - description: idCheckItem in: path name: idCheckItem required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsChecklistCheckItemConvertToCardByIdCardByIdChecklistByIdCheckItem() tags: - card '/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/name': put: operationId: updateCardsChecklistCheckItemNameByIdCardByIdChecklistByIdCheckItem parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idChecklist in: path name: idChecklist required: true type: string - description: idCheckItem in: path name: idCheckItem required: true type: string - description: Attributes of "Cards Checklist Check Item Name" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_checklist_checkItem_name' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsChecklistCheckItemNameByIdCardByIdChecklistByIdCheckItem() tags: - card '/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/pos': put: operationId: updateCardsChecklistCheckItemPosByIdCardByIdChecklistByIdCheckItem parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idChecklist in: path name: idChecklist required: true type: string - description: idCheckItem in: path name: idCheckItem required: true type: string - description: Attributes of "Cards Checklist Check Item Pos" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_checklist_checkItem_pos' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsChecklistCheckItemPosByIdCardByIdChecklistByIdCheckItem() tags: - card '/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/state': put: operationId: updateCardsChecklistCheckItemStateByIdCardByIdChecklistByIdCheckItem parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idChecklist in: path name: idChecklist required: true type: string - description: idCheckItem in: path name: idCheckItem required: true type: string - description: Attributes of "Cards Checklist Check Item State" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_checklist_checkItem_state' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsChecklistCheckItemStateByIdCardByIdChecklistByIdCheckItem() tags: - card '/cards/{idCard}/checklists': get: operationId: getCardsChecklistsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - default: none description: 'One of: all, closed, none, open or visible' in: query name: cards required: false type: string - default: all description: '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' in: query name: card_fields required: false type: string - default: all description: 'One of: all or none' in: query name: checkItems required: false type: string - default: 'name, nameData, pos and state' description: 'all or a comma-separated list of: name, nameData, pos, state or type' in: query name: checkItem_fields required: false type: string - default: all description: 'One of: all or none' in: query name: filter required: false type: string - default: all description: 'all or a comma-separated list of: idBoard, idCard, name or pos' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsChecklistsByIdCard() tags: - card post: operationId: addCardsChecklistsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Checklists" to be added. in: body name: body required: true schema: $ref: '#/definitions/cards_checklists' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsChecklistsByIdCard() tags: - card '/cards/{idCard}/checklists/{idChecklist}': delete: operationId: deleteCardsChecklistsByIdCardByIdChecklist parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idChecklist in: path name: idChecklist required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteCardsChecklistsByIdCardByIdChecklist() tags: - card '/cards/{idCard}/closed': put: operationId: updateCardsClosedByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Closed" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_closed' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsClosedByIdCard() tags: - card '/cards/{idCard}/desc': put: operationId: updateCardsDescByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Desc" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_desc' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsDescByIdCard() tags: - card '/cards/{idCard}/due': put: operationId: updateCardsDueByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Due" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_due' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsDueByIdCard() tags: - card '/cards/{idCard}/idAttachmentCover': put: operationId: updateCardsIdAttachmentCoverByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Id Attachment Cover" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_idAttachmentCover' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsIdAttachmentCoverByIdCard() tags: - card '/cards/{idCard}/idBoard': put: operationId: updateCardsIdBoardByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Id Board" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_idBoard' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsIdBoardByIdCard() tags: - card '/cards/{idCard}/idLabels': post: operationId: addCardsIdLabelsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Id Labels" to be added. in: body name: body required: true schema: $ref: '#/definitions/cards_idLabels' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsIdLabelsByIdCard() tags: - card '/cards/{idCard}/idLabels/{idLabel}': delete: operationId: deleteCardsIdLabelsByIdCardByIdLabel parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idLabel in: path name: idLabel required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteCardsIdLabelsByIdCardByIdLabel() tags: - card '/cards/{idCard}/idList': put: operationId: updateCardsIdListByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Id List" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_idList' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsIdListByIdCard() tags: - card '/cards/{idCard}/idMembers': post: operationId: addCardsIdMembersByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Id Members" to be added. in: body name: body required: true schema: $ref: '#/definitions/cards_idMembers' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsIdMembersByIdCard() tags: - card put: operationId: updateCardsIdMembersByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Id Members" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_idMembers' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsIdMembersByIdCard() tags: - card '/cards/{idCard}/idMembers/{idMember}': delete: operationId: deleteCardsIdMembersByIdCardByIdMember parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idMember in: path name: idMember required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteCardsIdMembersByIdCardByIdMember() tags: - card '/cards/{idCard}/labels': post: operationId: addCardsLabelsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Labels" to be added. in: body name: body required: true schema: $ref: '#/definitions/cards_labels' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsLabelsByIdCard() tags: - card put: operationId: updateCardsLabelsByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Labels" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_labels' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsLabelsByIdCard() tags: - card '/cards/{idCard}/labels/{color}': delete: operationId: deleteCardsLabelsByIdCardByColor parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: color in: path name: color required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteCardsLabelsByIdCardByColor() tags: - card '/cards/{idCard}/list': get: operationId: getCardsListByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - default: all description: 'all or a comma-separated list of: closed, idBoard, name, pos or subscribed' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsListByIdCard() tags: - card '/cards/{idCard}/list/{field}': get: operationId: getCardsListByIdCardByField parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsListByIdCardByField() tags: - card '/cards/{idCard}/markAssociatedNotificationsRead': post: operationId: addCardsMarkAssociatedNotificationsReadByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsMarkAssociatedNotificationsReadByIdCard() tags: - card '/cards/{idCard}/members': get: operationId: getCardsMembersByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsMembersByIdCard() tags: - card '/cards/{idCard}/membersVoted': get: operationId: getCardsMembersVotedByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsMembersVotedByIdCard() tags: - card post: operationId: addCardsMembersVotedByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Members Voted" to be added. in: body name: body required: true schema: $ref: '#/definitions/cards_membersVoted' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsMembersVotedByIdCard() tags: - card '/cards/{idCard}/membersVoted/{idMember}': delete: operationId: deleteCardsMembersVotedByIdCardByIdMember parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idMember in: path name: idMember required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteCardsMembersVotedByIdCardByIdMember() tags: - card '/cards/{idCard}/name': put: operationId: updateCardsNameByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Name" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_name' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsNameByIdCard() tags: - card '/cards/{idCard}/pos': put: operationId: updateCardsPosByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Pos" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_pos' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsPosByIdCard() tags: - card '/cards/{idCard}/stickers': get: operationId: getCardsStickersByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - default: all description: 'all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsStickersByIdCard() tags: - card post: operationId: addCardsStickersByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Stickers" to be added. in: body name: body required: true schema: $ref: '#/definitions/cards_stickers' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addCardsStickersByIdCard() tags: - card '/cards/{idCard}/stickers/{idSticker}': delete: operationId: deleteCardsStickersByIdCardByIdSticker parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idSticker in: path name: idSticker required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteCardsStickersByIdCardByIdSticker() tags: - card get: operationId: getCardsStickersByIdCardByIdSticker parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idSticker in: path name: idSticker required: true type: string - default: all description: 'all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getCardsStickersByIdCardByIdSticker() tags: - card put: operationId: updateCardsStickersByIdCardByIdSticker parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: idSticker in: path name: idSticker required: true type: string - description: Attributes of "Cards Stickers" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_stickers' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsStickersByIdCardByIdSticker() tags: - card '/cards/{idCard}/subscribed': put: operationId: updateCardsSubscribedByIdCard parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: Attributes of "Cards Subscribed" to be updated. in: body name: body required: true schema: $ref: '#/definitions/cards_subscribed' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateCardsSubscribedByIdCard() tags: - card '/cards/{idCard}/{field}': get: operationId: getCardsByIdCardByField parameters: - description: card id or shortlink in: path name: idCard required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getCardsByIdCardByField() tags: - card /checklists: post: operationId: addChecklists parameters: - description: Attributes of "Checklists" to be added. in: body name: body required: true schema: $ref: '#/definitions/checklists' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addChecklists() tags: - checklist '/checklists/{idChecklist}': delete: operationId: deleteChecklistsByIdChecklist parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteChecklistsByIdChecklist() tags: - checklist get: operationId: getChecklistsByIdChecklist parameters: - description: idChecklist in: path name: idChecklist required: true type: string - default: none description: 'One of: all, closed, none, open or visible' in: query name: cards required: false type: string - default: all description: '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' in: query name: card_fields required: false type: string - default: all description: 'One of: all or none' in: query name: checkItems required: false type: string - default: 'name, nameData, pos and state' description: 'all or a comma-separated list of: name, nameData, pos, state or type' in: query name: checkItem_fields required: false type: string - default: all description: 'all or a comma-separated list of: idBoard, idCard, name or pos' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getChecklistsByIdChecklist() tags: - checklist put: operationId: updateChecklistsByIdChecklist parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: Attributes of "Checklists" to be updated. in: body name: body required: true schema: $ref: '#/definitions/checklists' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateChecklistsByIdChecklist() tags: - checklist '/checklists/{idChecklist}/board': get: operationId: getChecklistsBoardByIdChecklist parameters: - description: idChecklist in: path name: idChecklist required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getChecklistsBoardByIdChecklist() tags: - checklist '/checklists/{idChecklist}/board/{field}': get: operationId: getChecklistsBoardByIdChecklistByField parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getChecklistsBoardByIdChecklistByField() tags: - checklist '/checklists/{idChecklist}/cards': get: operationId: getChecklistsCardsByIdChecklist parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: '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' in: query name: actions required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: attachments required: false type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: attachment_fields required: false type: string - description: ' true or false' in: query name: stickers required: false type: string - description: ' true or false' in: query name: members required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: checkItemStates required: false type: string - default: none description: 'One of: all or none' in: query name: checklists required: false type: string - description: a number from 1 to 1000 in: query name: limit required: false type: string - description: 'A date, or null' in: query name: since required: false type: string - description: 'A date, or null' in: query name: before required: false type: string - default: open description: 'One of: all, closed, none or open' in: query name: filter required: false type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getChecklistsCardsByIdChecklist() tags: - checklist '/checklists/{idChecklist}/cards/{filter}': get: operationId: getChecklistsCardsByIdChecklistByFilter parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getChecklistsCardsByIdChecklistByFilter() tags: - checklist '/checklists/{idChecklist}/checkItems': get: operationId: getChecklistsCheckItemsByIdChecklist parameters: - description: idChecklist in: path name: idChecklist required: true type: string - default: all description: 'One of: all or none' in: query name: filter required: false type: string - default: 'name, nameData, pos and state' description: 'all or a comma-separated list of: name, nameData, pos, state or type' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getChecklistsCheckItemsByIdChecklist() tags: - checklist post: operationId: addChecklistsCheckItemsByIdChecklist parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: Attributes of "Checklists Check Items" to be added. in: body name: body required: true schema: $ref: '#/definitions/checklists_checkItems' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addChecklistsCheckItemsByIdChecklist() tags: - checklist '/checklists/{idChecklist}/checkItems/{idCheckItem}': delete: operationId: deleteChecklistsCheckItemsByIdChecklistByIdCheckItem parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: idCheckItem in: path name: idCheckItem required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteChecklistsCheckItemsByIdChecklistByIdCheckItem() tags: - checklist get: operationId: getChecklistsCheckItemsByIdChecklistByIdCheckItem parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: idCheckItem in: path name: idCheckItem required: true type: string - default: 'name, nameData, pos and state' description: 'all or a comma-separated list of: name, nameData, pos, state or type' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getChecklistsCheckItemsByIdChecklistByIdCheckItem() tags: - checklist '/checklists/{idChecklist}/idCard': put: operationId: updateChecklistsIdCardByIdChecklist parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: Attributes of "Checklists Id Card" to be updated. in: body name: body required: true schema: $ref: '#/definitions/checklists_idCard' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateChecklistsIdCardByIdChecklist() tags: - checklist '/checklists/{idChecklist}/name': put: operationId: updateChecklistsNameByIdChecklist parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: Attributes of "Checklists Name" to be updated. in: body name: body required: true schema: $ref: '#/definitions/checklists_name' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateChecklistsNameByIdChecklist() tags: - checklist '/checklists/{idChecklist}/pos': put: operationId: updateChecklistsPosByIdChecklist parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: Attributes of "Checklists Pos" to be updated. in: body name: body required: true schema: $ref: '#/definitions/checklists_pos' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateChecklistsPosByIdChecklist() tags: - checklist '/checklists/{idChecklist}/{field}': get: operationId: getChecklistsByIdChecklistByField parameters: - description: idChecklist in: path name: idChecklist required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getChecklistsByIdChecklistByField() tags: - checklist /labels: post: operationId: addLabels parameters: - description: Attributes of "Labels" to be added. in: body name: body required: true schema: $ref: '#/definitions/labels' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addLabels() tags: - label '/labels/{idLabel}': delete: operationId: deleteLabelsByIdLabel parameters: - description: idLabel in: path name: idLabel required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteLabelsByIdLabel() tags: - label get: operationId: getLabelsByIdLabel parameters: - description: idLabel in: path name: idLabel required: true type: string - default: all description: 'all or a comma-separated list of: color, idBoard, name or uses' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getLabelsByIdLabel() tags: - label put: operationId: updateLabelsByIdLabel parameters: - description: idLabel in: path name: idLabel required: true type: string - description: Attributes of "Labels" to be updated. in: body name: body required: true schema: $ref: '#/definitions/labels' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateLabelsByIdLabel() tags: - label '/labels/{idLabel}/board': get: operationId: getLabelsBoardByIdLabel parameters: - description: idLabel in: path name: idLabel required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getLabelsBoardByIdLabel() tags: - label '/labels/{idLabel}/board/{field}': get: operationId: getLabelsBoardByIdLabelByField parameters: - description: idLabel in: path name: idLabel required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getLabelsBoardByIdLabelByField() tags: - label '/labels/{idLabel}/color': put: operationId: updateLabelsColorByIdLabel parameters: - description: idLabel in: path name: idLabel required: true type: string - description: Attributes of "Labels Color" to be updated. in: body name: body required: true schema: $ref: '#/definitions/labels_color' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateLabelsColorByIdLabel() tags: - label '/labels/{idLabel}/name': put: operationId: updateLabelsNameByIdLabel parameters: - description: idLabel in: path name: idLabel required: true type: string - description: Attributes of "Labels Name" to be updated. in: body name: body required: true schema: $ref: '#/definitions/labels_name' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateLabelsNameByIdLabel() tags: - label /lists: post: operationId: addLists parameters: - description: Attributes of "Lists" to be added. in: body name: body required: true schema: $ref: '#/definitions/lists' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addLists() tags: - list '/lists/{idList}': get: operationId: getListsByIdList parameters: - description: idList in: path name: idList required: true type: string - default: none description: 'One of: all, closed, none or open' in: query name: cards required: false type: string - default: all description: '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' in: query name: card_fields required: false type: string - description: ' true or false' in: query name: board required: false type: string - default: 'name, desc, descData, closed, idOrganization, pinned, url and prefs' description: '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' in: query name: board_fields required: false type: string - default: 'name, closed, idBoard and pos' description: 'all or a comma-separated list of: closed, idBoard, name, pos or subscribed' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getListsByIdList() tags: - list put: operationId: updateListsByIdList parameters: - description: idList in: path name: idList required: true type: string - description: Attributes of "Lists" to be updated. in: body name: body required: true schema: $ref: '#/definitions/lists' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateListsByIdList() tags: - list '/lists/{idList}/actions': get: operationId: getListsActionsByIdList parameters: - description: idList in: path name: idList required: true type: string - description: ' true or false' in: query name: entities required: false type: string - description: ' true or false' in: query name: display required: false type: string - default: all description: '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' in: query name: filter required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: fields required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: limit required: false type: string - default: list description: 'One of: count, list or minimal' in: query name: format required: false type: string - description: 'A date, null or lastView' in: query name: since required: false type: string - description: 'A date, or null' in: query name: before required: false type: string - default: '0' description: Page * limit must be less than 1000 in: query name: page required: false type: string - description: Only return actions related to these model ids in: query name: idModels required: false type: string - description: ' true or false' in: query name: member required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: memberCreator required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberCreator_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getListsActionsByIdList() tags: - list '/lists/{idList}/archiveAllCards': post: operationId: addListsArchiveAllCardsByIdList parameters: - description: idList in: path name: idList required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addListsArchiveAllCardsByIdList() tags: - list '/lists/{idList}/board': get: operationId: getListsBoardByIdList parameters: - description: idList in: path name: idList required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getListsBoardByIdList() tags: - list '/lists/{idList}/board/{field}': get: operationId: getListsBoardByIdListByField parameters: - description: idList in: path name: idList required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getListsBoardByIdListByField() tags: - list '/lists/{idList}/cards': get: operationId: getListsCardsByIdList parameters: - description: idList in: path name: idList required: true type: string - description: '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' in: query name: actions required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: attachments required: false type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: attachment_fields required: false type: string - description: ' true or false' in: query name: stickers required: false type: string - description: ' true or false' in: query name: members required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: checkItemStates required: false type: string - default: none description: 'One of: all or none' in: query name: checklists required: false type: string - description: a number from 1 to 1000 in: query name: limit required: false type: string - description: 'A date, or null' in: query name: since required: false type: string - description: 'A date, or null' in: query name: before required: false type: string - default: open description: 'One of: all, closed, none or open' in: query name: filter required: false type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getListsCardsByIdList() tags: - list post: operationId: addListsCardsByIdList parameters: - description: idList in: path name: idList required: true type: string - description: Attributes of "Lists Cards" to be added. in: body name: body required: true schema: $ref: '#/definitions/lists_cards' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addListsCardsByIdList() tags: - list '/lists/{idList}/cards/{filter}': get: operationId: getListsCardsByIdListByFilter parameters: - description: idList in: path name: idList required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getListsCardsByIdListByFilter() tags: - list '/lists/{idList}/closed': put: operationId: updateListsClosedByIdList parameters: - description: idList in: path name: idList required: true type: string - description: Attributes of "Lists Closed" to be updated. in: body name: body required: true schema: $ref: '#/definitions/lists_closed' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateListsClosedByIdList() tags: - list '/lists/{idList}/idBoard': put: operationId: updateListsIdBoardByIdList parameters: - description: idList in: path name: idList required: true type: string - description: Attributes of "Lists Id Board" to be updated. in: body name: body required: true schema: $ref: '#/definitions/lists_idBoard' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateListsIdBoardByIdList() tags: - list '/lists/{idList}/moveAllCards': post: operationId: addListsMoveAllCardsByIdList parameters: - description: idList in: path name: idList required: true type: string - description: Attributes of "Lists Move All Cards" to be added. in: body name: body required: true schema: $ref: '#/definitions/lists_moveAllCards' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addListsMoveAllCardsByIdList() tags: - list '/lists/{idList}/name': put: operationId: updateListsNameByIdList parameters: - description: idList in: path name: idList required: true type: string - description: Attributes of "Lists Name" to be updated. in: body name: body required: true schema: $ref: '#/definitions/lists_name' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateListsNameByIdList() tags: - list '/lists/{idList}/pos': put: operationId: updateListsPosByIdList parameters: - description: idList in: path name: idList required: true type: string - description: Attributes of "Lists Pos" to be updated. in: body name: body required: true schema: $ref: '#/definitions/lists_pos' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateListsPosByIdList() tags: - list '/lists/{idList}/subscribed': put: operationId: updateListsSubscribedByIdList parameters: - description: idList in: path name: idList required: true type: string - description: Attributes of "Lists Subscribed" to be updated. in: body name: body required: true schema: $ref: '#/definitions/lists_subscribed' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateListsSubscribedByIdList() tags: - list '/lists/{idList}/{field}': get: operationId: getListsByIdListByField parameters: - description: idList in: path name: idList required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getListsByIdListByField() tags: - list '/members/{idMember}': get: description: 'If you specify ''me'' as the username, this call will respond as if you had supplied the username associated with the supplied token' operationId: getMembersByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: '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' in: query name: actions required: false type: string - description: ' true or false' in: query name: actions_entities required: false type: string - description: ' true or false' in: query name: actions_display required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: actions_limit required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: action_fields required: false type: string - description: 'A date, null or lastView' in: query name: action_since required: false type: string - description: 'A date, or null' in: query name: action_before required: false type: string - default: none description: 'One of: all, closed, none, open or visible' in: query name: cards required: false type: string - default: all description: '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' in: query name: card_fields required: false type: string - description: ' true or false' in: query name: card_members required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: card_member_fields required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: card_attachments required: false type: string - default: url and previews description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: card_attachment_fields required: false type: string - description: ' true or false' in: query name: card_stickers required: false type: string - description: 'all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned' in: query name: boards required: false type: string - default: 'name, closed, idOrganization and pinned' description: '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' in: query name: board_fields required: false type: string - description: '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' in: query name: board_actions required: false type: string - description: ' true or false' in: query name: board_actions_entities required: false type: string - description: ' true or false' in: query name: board_actions_display required: false type: string - default: list description: 'One of: count, list or minimal' in: query name: board_actions_format required: false type: string - description: 'A date, null or lastView' in: query name: board_actions_since required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: board_actions_limit required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: board_action_fields required: false type: string - default: none description: 'One of: all, closed, none or open' in: query name: board_lists required: false type: string - default: none description: 'all or a comma-separated list of: active, admin, deactivated, me or normal' in: query name: board_memberships required: false type: string - description: ' true or false' in: query name: board_organization required: false type: string - default: name and displayName description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: board_organization_fields required: false type: string - description: 'all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned' in: query name: boardsInvited required: false type: string - default: 'name, closed, idOrganization and pinned' description: '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' in: query name: boardsInvited_fields required: false type: string - description: ' true or false' in: query name: boardStars required: false type: string - description: ' true or false' in: query name: savedSearches required: false type: string - default: none description: 'One of: all, members, none or public' in: query name: organizations required: false type: string - default: all description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: organization_fields required: false type: string - description: ' true or false' in: query name: organization_paid_account required: false type: string - default: none description: 'One of: all, members, none or public' in: query name: organizationsInvited required: false type: string - default: all description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: organizationsInvited_fields required: false type: string - description: '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' in: query name: notifications required: false type: string - description: ' true or false' in: query name: notifications_entities required: false type: string - description: ' true or false' in: query name: notifications_display required: false type: string - default: '50' description: a number from 1 to 1000 in: query name: notifications_limit required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator, type or unread' in: query name: notification_fields required: false type: string - description: ' true or false' in: query name: notification_memberCreator required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: notification_memberCreator_fields required: false type: string - description: 'An id, or null' in: query name: notification_before required: false type: string - description: 'An id, or null' in: query name: notification_since required: false type: string - default: none description: 'One of: all or none' in: query name: tokens required: false type: string - description: ' true or false' in: query name: paid_account required: false type: string - default: none description: 'One of: all, custom, default, none or premium' in: query name: boardBackgrounds required: false type: string - default: none description: 'One of: all or none' in: query name: customBoardBackgrounds required: false type: string - default: none description: 'One of: all or none' in: query name: customStickers required: false type: string - default: none description: 'One of: all or none' in: query name: customEmoji required: false type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersByIdMember() tags: - member put: operationId: updateMembersByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersByIdMember() tags: - member '/members/{idMember}/actions': get: operationId: getMembersActionsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: ' true or false' in: query name: entities required: false type: string - description: ' true or false' in: query name: display required: false type: string - default: all description: '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' in: query name: filter required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: fields required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: limit required: false type: string - default: list description: 'One of: count, list or minimal' in: query name: format required: false type: string - description: 'A date, null or lastView' in: query name: since required: false type: string - description: 'A date, or null' in: query name: before required: false type: string - default: '0' description: Page * limit must be less than 1000 in: query name: page required: false type: string - description: Only return actions related to these model ids in: query name: idModels required: false type: string - description: ' true or false' in: query name: member required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: memberCreator required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberCreator_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersActionsByIdMember() tags: - member '/members/{idMember}/avatar': post: operationId: addMembersAvatarByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Avatar" to be added. in: body name: body required: true schema: $ref: '#/definitions/members_avatar' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addMembersAvatarByIdMember() tags: - member '/members/{idMember}/avatarSource': put: operationId: updateMembersAvatarSourceByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Avatar Source" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_avatarSource' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersAvatarSourceByIdMember() tags: - member '/members/{idMember}/bio': put: operationId: updateMembersBioByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Bio" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_bio' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersBioByIdMember() tags: - member '/members/{idMember}/boardBackgrounds': get: operationId: getMembersBoardBackgroundsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - default: all description: 'One of: all, custom, default, none or premium' in: query name: filter required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersBoardBackgroundsByIdMember() tags: - member post: operationId: addMembersBoardBackgroundsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Board Backgrounds" to be added. in: body name: body required: true schema: $ref: '#/definitions/members_boardBackgrounds' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addMembersBoardBackgroundsByIdMember() tags: - member '/members/{idMember}/boardBackgrounds/{idBoardBackground}': delete: operationId: deleteMembersBoardBackgroundsByIdMemberByIdBoardBackground parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardBackground in: path name: idBoardBackground required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteMembersBoardBackgroundsByIdMemberByIdBoardBackground() tags: - member get: operationId: getMembersBoardBackgroundsByIdMemberByIdBoardBackground parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardBackground in: path name: idBoardBackground required: true type: string - default: all description: 'all or a comma-separated list of: brightness, fullSizeUrl, scaled or tile' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersBoardBackgroundsByIdMemberByIdBoardBackground() tags: - member put: operationId: updateMembersBoardBackgroundsByIdMemberByIdBoardBackground parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardBackground in: path name: idBoardBackground required: true type: string - description: Attributes of "Members Board Backgrounds" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_boardBackgrounds' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersBoardBackgroundsByIdMemberByIdBoardBackground() tags: - member '/members/{idMember}/boardStars': get: operationId: getMembersBoardStarsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersBoardStarsByIdMember() tags: - member post: operationId: addMembersBoardStarsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Board Stars" to be added. in: body name: body required: true schema: $ref: '#/definitions/members_boardStars' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addMembersBoardStarsByIdMember() tags: - member '/members/{idMember}/boardStars/{idBoardStar}': delete: operationId: deleteMembersBoardStarsByIdMemberByIdBoardStar parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardStar in: path name: idBoardStar required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteMembersBoardStarsByIdMemberByIdBoardStar() tags: - member get: operationId: getMembersBoardStarsByIdMemberByIdBoardStar parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardStar in: path name: idBoardStar required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersBoardStarsByIdMemberByIdBoardStar() tags: - member put: operationId: updateMembersBoardStarsByIdMemberByIdBoardStar parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardStar in: path name: idBoardStar required: true type: string - description: Attributes of "Members Board Stars" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_boardStars' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersBoardStarsByIdMemberByIdBoardStar() tags: - member '/members/{idMember}/boardStars/{idBoardStar}/idBoard': put: operationId: updateMembersBoardStarsIdBoardByIdMemberByIdBoardStar parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardStar in: path name: idBoardStar required: true type: string - description: Attributes of "Members Board Stars Id Board" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_boardStars_idBoard' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersBoardStarsIdBoardByIdMemberByIdBoardStar() tags: - member '/members/{idMember}/boardStars/{idBoardStar}/pos': put: operationId: updateMembersBoardStarsPosByIdMemberByIdBoardStar parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardStar in: path name: idBoardStar required: true type: string - description: Attributes of "Members Board Stars Pos" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_boardStars_pos' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersBoardStarsPosByIdMemberByIdBoardStar() tags: - member '/members/{idMember}/boards': get: operationId: getMembersBoardsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - default: all description: 'all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned' in: query name: filter required: false type: string - default: all description: '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' in: query name: fields required: false type: string - description: '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' in: query name: actions required: false type: string - description: ' true or false' in: query name: actions_entities required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: actions_limit required: false type: string - default: list description: 'One of: count, list or minimal' in: query name: actions_format required: false type: string - description: 'A date, null or lastView' in: query name: actions_since required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: action_fields required: false type: string - default: none description: 'all or a comma-separated list of: active, admin, deactivated, me or normal' in: query name: memberships required: false type: string - description: ' true or false' in: query name: organization required: false type: string - default: name and displayName description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: organization_fields required: false type: string - default: none description: 'One of: all, closed, none or open' in: query name: lists required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersBoardsByIdMember() tags: - member '/members/{idMember}/boards/{filter}': get: operationId: getMembersBoardsByIdMemberByFilter parameters: - description: idMember or username in: path name: idMember required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getMembersBoardsByIdMemberByFilter() tags: - member '/members/{idMember}/boardsInvited': get: operationId: getMembersBoardsInvitedByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersBoardsInvitedByIdMember() tags: - member '/members/{idMember}/boardsInvited/{field}': get: operationId: getMembersBoardsInvitedByIdMemberByField parameters: - description: idMember or username in: path name: idMember required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersBoardsInvitedByIdMemberByField() tags: - member '/members/{idMember}/cards': get: operationId: getMembersCardsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: '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' in: query name: actions required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: attachments required: false type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: attachment_fields required: false type: string - description: ' true or false' in: query name: stickers required: false type: string - description: ' true or false' in: query name: members required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: checkItemStates required: false type: string - default: none description: 'One of: all or none' in: query name: checklists required: false type: string - description: a number from 1 to 1000 in: query name: limit required: false type: string - description: 'A date, or null' in: query name: since required: false type: string - description: 'A date, or null' in: query name: before required: false type: string - default: visible description: 'One of: all, closed, none, open or visible' in: query name: filter required: false type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersCardsByIdMember() tags: - member '/members/{idMember}/cards/{filter}': get: operationId: getMembersCardsByIdMemberByFilter parameters: - description: idMember or username in: path name: idMember required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getMembersCardsByIdMemberByFilter() tags: - member '/members/{idMember}/customBoardBackgrounds': get: operationId: getMembersCustomBoardBackgroundsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - default: all description: 'One of: all or none' in: query name: filter required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersCustomBoardBackgroundsByIdMember() tags: - member post: operationId: addMembersCustomBoardBackgroundsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Custom Board Backgrounds" to be added. in: body name: body required: true schema: $ref: '#/definitions/members_customBoardBackgrounds' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addMembersCustomBoardBackgroundsByIdMember() tags: - member '/members/{idMember}/customBoardBackgrounds/{idBoardBackground}': delete: operationId: deleteMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardBackground in: path name: idBoardBackground required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground() tags: - member get: operationId: getMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardBackground in: path name: idBoardBackground required: true type: string - default: all description: 'all or a comma-separated list of: brightness, fullSizeUrl, scaled or tile' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground() tags: - member put: operationId: updateMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idBoardBackground in: path name: idBoardBackground required: true type: string - description: Attributes of "Members Custom Board Backgrounds" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_customBoardBackgrounds' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground() tags: - member '/members/{idMember}/customEmoji': get: description: This gets the list of all of the user’s uploaded emoji operationId: getMembersCustomEmojiByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - default: all description: 'One of: all or none' in: query name: filter required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersCustomEmojiByIdMember() tags: - member post: operationId: addMembersCustomEmojiByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Custom Emoji" to be added. in: body name: body required: true schema: $ref: '#/definitions/members_customEmoji' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addMembersCustomEmojiByIdMember() tags: - member '/members/{idMember}/customEmoji/{idCustomEmoji}': get: operationId: getMembersCustomEmojiByIdMemberByIdCustomEmoji parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idCustomEmoji in: path name: idCustomEmoji required: true type: string - default: all description: 'all or a comma-separated list of: name or url' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersCustomEmojiByIdMemberByIdCustomEmoji() tags: - member '/members/{idMember}/customStickers': get: description: This gets a list of all of the user’s uploaded stickers operationId: getMembersCustomStickersByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - default: all description: 'One of: all or none' in: query name: filter required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersCustomStickersByIdMember() tags: - member post: operationId: addMembersCustomStickersByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Custom Stickers" to be added. in: body name: body required: true schema: $ref: '#/definitions/members_customStickers' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addMembersCustomStickersByIdMember() tags: - member '/members/{idMember}/customStickers/{idCustomSticker}': delete: operationId: deleteMembersCustomStickersByIdMemberByIdCustomSticker parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idCustomSticker in: path name: idCustomSticker required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteMembersCustomStickersByIdMemberByIdCustomSticker() tags: - member get: operationId: getMembersCustomStickersByIdMemberByIdCustomSticker parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idCustomSticker in: path name: idCustomSticker required: true type: string - default: all description: 'all or a comma-separated list of: scaled or url' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersCustomStickersByIdMemberByIdCustomSticker() tags: - member '/members/{idMember}/deltas': get: operationId: getMembersDeltasByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: A valid tag for subscribing in: query name: tags required: true type: string - description: a number from -1 to Infinity in: query name: ixLastUpdate required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersDeltasByIdMember() tags: - member '/members/{idMember}/fullName': put: operationId: updateMembersFullNameByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Full Name" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_fullName' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersFullNameByIdMember() tags: - member '/members/{idMember}/initials': put: operationId: updateMembersInitialsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Initials" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_initials' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersInitialsByIdMember() tags: - member '/members/{idMember}/notifications': get: description: You can only read the notifications for the member associated with the supplied token operationId: getMembersNotificationsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: ' true or false' in: query name: entities required: false type: string - description: ' true or false' in: query name: display required: false type: string - default: all description: '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' in: query name: filter required: false type: string - default: all description: 'One of: all, read or unread' in: query name: read_filter required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator, type or unread' in: query name: fields required: false type: string - default: '50' description: a number from 1 to 1000 in: query name: limit required: false type: string - default: '0' description: a number from 0 to 100 in: query name: page required: false type: string - description: 'An id, or null' in: query name: before required: false type: string - description: 'An id, or null' in: query name: since required: false type: string - description: ' true or false' in: query name: memberCreator required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberCreator_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersNotificationsByIdMember() tags: - member '/members/{idMember}/notifications/{filter}': get: operationId: getMembersNotificationsByIdMemberByFilter parameters: - description: idMember or username in: path name: idMember required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getMembersNotificationsByIdMemberByFilter() tags: - member '/members/{idMember}/oneTimeMessagesDismissed': post: operationId: addMembersOneTimeMessagesDismissedByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members One Time Messages Dismissed" to be added. in: body name: body required: true schema: $ref: '#/definitions/members_oneTimeMessagesDismissed' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addMembersOneTimeMessagesDismissedByIdMember() tags: - member '/members/{idMember}/organizations': get: operationId: getMembersOrganizationsByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - default: all description: 'One of: all, members, none or public' in: query name: filter required: false type: string - default: all description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: fields required: false type: string - description: ' true or false' in: query name: paid_account required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersOrganizationsByIdMember() tags: - member '/members/{idMember}/organizations/{filter}': get: operationId: getMembersOrganizationsByIdMemberByFilter parameters: - description: idMember or username in: path name: idMember required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getMembersOrganizationsByIdMemberByFilter() tags: - member '/members/{idMember}/organizationsInvited': get: operationId: getMembersOrganizationsInvitedByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - default: all description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersOrganizationsInvitedByIdMember() tags: - member '/members/{idMember}/organizationsInvited/{field}': get: operationId: getMembersOrganizationsInvitedByIdMemberByField parameters: - description: idMember or username in: path name: idMember required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersOrganizationsInvitedByIdMemberByField() tags: - member '/members/{idMember}/prefs/colorBlind': put: operationId: updateMembersPrefsColorBlindByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Prefs Color Blind" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_colorBlind' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersPrefsColorBlindByIdMember() tags: - member '/members/{idMember}/prefs/locale': put: operationId: updateMembersPrefsLocaleByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Prefs Locale" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_locale' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersPrefsLocaleByIdMember() tags: - member '/members/{idMember}/prefs/minutesBetweenSummaries': put: operationId: updateMembersPrefsMinutesBetweenSummariesByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Prefs Minutes Between Summaries" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_minutesBetweenSummaries' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersPrefsMinutesBetweenSummariesByIdMember() tags: - member '/members/{idMember}/savedSearches': get: operationId: getMembersSavedSearchesByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersSavedSearchesByIdMember() tags: - member post: operationId: addMembersSavedSearchesByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Saved Searches" to be added. in: body name: body required: true schema: $ref: '#/definitions/members_savedSearches' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addMembersSavedSearchesByIdMember() tags: - member '/members/{idMember}/savedSearches/{idSavedSearch}': delete: operationId: deleteMembersSavedSearchesByIdMemberByIdSavedSearch parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idSavedSearch in: path name: idSavedSearch required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteMembersSavedSearchesByIdMemberByIdSavedSearch() tags: - member get: operationId: getMembersSavedSearchesByIdMemberByIdSavedSearch parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idSavedSearch in: path name: idSavedSearch required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersSavedSearchesByIdMemberByIdSavedSearch() tags: - member put: operationId: updateMembersSavedSearchesByIdMemberByIdSavedSearch parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idSavedSearch in: path name: idSavedSearch required: true type: string - description: Attributes of "Members Saved Searches" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_savedSearches' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersSavedSearchesByIdMemberByIdSavedSearch() tags: - member '/members/{idMember}/savedSearches/{idSavedSearch}/name': put: operationId: updateMembersSavedSearchesNameByIdMemberByIdSavedSearch parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idSavedSearch in: path name: idSavedSearch required: true type: string - description: Attributes of "Members Saved Searches Name" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_savedSearches_name' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersSavedSearchesNameByIdMemberByIdSavedSearch() tags: - member '/members/{idMember}/savedSearches/{idSavedSearch}/pos': put: operationId: updateMembersSavedSearchesPosByIdMemberByIdSavedSearch parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idSavedSearch in: path name: idSavedSearch required: true type: string - description: Attributes of "Members Saved Searches Pos" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_savedSearches_pos' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersSavedSearchesPosByIdMemberByIdSavedSearch() tags: - member '/members/{idMember}/savedSearches/{idSavedSearch}/query': put: operationId: updateMembersSavedSearchesQueryByIdMemberByIdSavedSearch parameters: - description: idMember or username in: path name: idMember required: true type: string - description: idSavedSearch in: path name: idSavedSearch required: true type: string - description: Attributes of "Members Saved Searches Query" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_savedSearches_query' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersSavedSearchesQueryByIdMemberByIdSavedSearch() tags: - member '/members/{idMember}/tokens': get: operationId: getMembersTokensByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - default: all description: 'One of: all or none' in: query name: filter required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getMembersTokensByIdMember() tags: - member '/members/{idMember}/username': put: operationId: updateMembersUsernameByIdMember parameters: - description: idMember or username in: path name: idMember required: true type: string - description: Attributes of "Members Username" to be updated. in: body name: body required: true schema: $ref: '#/definitions/members_username' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateMembersUsernameByIdMember() tags: - member '/members/{idMember}/{field}': get: operationId: getMembersByIdMemberByField parameters: - description: idMember or username in: path name: idMember required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getMembersByIdMemberByField() tags: - member /notifications/all/read: post: operationId: addNotificationsAllRead parameters: - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addNotificationsAllRead() tags: - notification '/notifications/{idNotification}': get: operationId: getNotificationsByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - description: ' true or false' in: query name: display required: false type: string - description: ' true or false' in: query name: entities required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator, type or unread' in: query name: fields required: false type: string - description: ' true or false' in: query name: memberCreator required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberCreator_fields required: false type: string - description: ' true or false' in: query name: board required: false type: string - default: name description: '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' in: query name: board_fields required: false type: string - description: ' true or false' in: query name: list required: false type: string - description: ' true or false' in: query name: card required: false type: string - default: name description: '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' in: query name: card_fields required: false type: string - description: ' true or false' in: query name: organization required: false type: string - default: displayName description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: organization_fields required: false type: string - description: ' true or false' in: query name: member required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsByIdNotification() tags: - notification put: operationId: updateNotificationsByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - description: Attributes of "Notifications" to be updated. in: body name: body required: true schema: $ref: '#/definitions/notifications' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateNotificationsByIdNotification() tags: - notification '/notifications/{idNotification}/board': get: operationId: getNotificationsBoardByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsBoardByIdNotification() tags: - notification '/notifications/{idNotification}/board/{field}': get: operationId: getNotificationsBoardByIdNotificationByField parameters: - description: idNotification in: path name: idNotification required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsBoardByIdNotificationByField() tags: - notification '/notifications/{idNotification}/card': get: operationId: getNotificationsCardByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsCardByIdNotification() tags: - notification '/notifications/{idNotification}/card/{field}': get: operationId: getNotificationsCardByIdNotificationByField parameters: - description: idNotification in: path name: idNotification required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsCardByIdNotificationByField() tags: - notification '/notifications/{idNotification}/display': get: operationId: getNotificationsDisplayByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsDisplayByIdNotification() tags: - notification '/notifications/{idNotification}/entities': get: operationId: getNotificationsEntitiesByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsEntitiesByIdNotification() tags: - notification '/notifications/{idNotification}/list': get: operationId: getNotificationsListByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - default: all description: 'all or a comma-separated list of: closed, idBoard, name, pos or subscribed' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsListByIdNotification() tags: - notification '/notifications/{idNotification}/list/{field}': get: operationId: getNotificationsListByIdNotificationByField parameters: - description: idNotification in: path name: idNotification required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsListByIdNotificationByField() tags: - notification '/notifications/{idNotification}/member': get: operationId: getNotificationsMemberByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsMemberByIdNotification() tags: - notification '/notifications/{idNotification}/member/{field}': get: operationId: getNotificationsMemberByIdNotificationByField parameters: - description: idNotification in: path name: idNotification required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsMemberByIdNotificationByField() tags: - notification '/notifications/{idNotification}/memberCreator': get: operationId: getNotificationsMemberCreatorByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsMemberCreatorByIdNotification() tags: - notification '/notifications/{idNotification}/memberCreator/{field}': get: operationId: getNotificationsMemberCreatorByIdNotificationByField parameters: - description: idNotification in: path name: idNotification required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsMemberCreatorByIdNotificationByField() tags: - notification '/notifications/{idNotification}/organization': get: operationId: getNotificationsOrganizationByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - default: all description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsOrganizationByIdNotification() tags: - notification '/notifications/{idNotification}/organization/{field}': get: operationId: getNotificationsOrganizationByIdNotificationByField parameters: - description: idNotification in: path name: idNotification required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getNotificationsOrganizationByIdNotificationByField() tags: - notification '/notifications/{idNotification}/unread': put: operationId: updateNotificationsUnreadByIdNotification parameters: - description: idNotification in: path name: idNotification required: true type: string - description: Attributes of "Notifications Unread" to be updated. in: body name: body required: true schema: $ref: '#/definitions/notifications_unread' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateNotificationsUnreadByIdNotification() tags: - notification '/notifications/{idNotification}/{field}': get: operationId: getNotificationsByIdNotificationByField parameters: - description: idNotification in: path name: idNotification required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getNotificationsByIdNotificationByField() tags: - notification /organizations: post: operationId: addOrganizations parameters: - description: Attributes of "Organizations" to be added. in: body name: body required: true schema: $ref: '#/definitions/organizations' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addOrganizations() tags: - organization '/organizations/{idOrg}': delete: operationId: deleteOrganizationsByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteOrganizationsByIdOrg() tags: - organization get: operationId: getOrganizationsByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: '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' in: query name: actions required: false type: string - description: ' true or false' in: query name: actions_entities required: false type: string - description: ' true or false' in: query name: actions_display required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: actions_limit required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: action_fields required: false type: string - default: none description: 'all or a comma-separated list of: active, admin, deactivated, me or normal' in: query name: memberships required: false type: string - description: ' true or false' in: query name: memberships_member required: false type: string - default: fullName and username description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberships_member_fields required: false type: string - default: none description: 'One of: admins, all, none, normal or owners' in: query name: members required: false type: string - default: 'avatarHash, fullName, initials, username and confirmed' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: true or false ; works for premium organizations only. in: query name: member_activity required: false type: string - default: none description: 'One of: admins, all, none, normal or owners' in: query name: membersInvited required: false type: string - default: 'avatarHash, initials, fullName and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: membersInvited_fields required: false type: string - default: none description: 'all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned' in: query name: boards required: false type: string - default: all description: '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' in: query name: board_fields required: false type: string - description: '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' in: query name: board_actions required: false type: string - description: ' true or false' in: query name: board_actions_entities required: false type: string - description: ' true or false' in: query name: board_actions_display required: false type: string - default: list description: 'One of: count, list or minimal' in: query name: board_actions_format required: false type: string - description: 'A date, null or lastView' in: query name: board_actions_since required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: board_actions_limit required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: board_action_fields required: false type: string - default: none description: 'One of: all, closed, none or open' in: query name: board_lists required: false type: string - description: ' true or false' in: query name: paid_account required: false type: string - default: 'name, displayName, desc, descData, url, website, logoHash, products and powerUps' description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getOrganizationsByIdOrg() tags: - organization put: operationId: updateOrganizationsByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Organizations" to be updated. in: body name: body required: true schema: $ref: '#/definitions/organizations' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsByIdOrg() tags: - organization '/organizations/{idOrg}/actions': get: operationId: getOrganizationsActionsByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: ' true or false' in: query name: entities required: false type: string - description: ' true or false' in: query name: display required: false type: string - default: all description: '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' in: query name: filter required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: fields required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: limit required: false type: string - default: list description: 'One of: count, list or minimal' in: query name: format required: false type: string - description: 'A date, null or lastView' in: query name: since required: false type: string - description: 'A date, or null' in: query name: before required: false type: string - default: '0' description: Page * limit must be less than 1000 in: query name: page required: false type: string - description: Only return actions related to these model ids in: query name: idModels required: false type: string - description: ' true or false' in: query name: member required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: memberCreator required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: memberCreator_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getOrganizationsActionsByIdOrg() tags: - organization '/organizations/{idOrg}/boards': get: operationId: getOrganizationsBoardsByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - default: all description: 'all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned' in: query name: filter required: false type: string - default: all description: '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' in: query name: fields required: false type: string - description: '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' in: query name: actions required: false type: string - description: ' true or false' in: query name: actions_entities required: false type: string - default: '50' description: a number from 0 to 1000 in: query name: actions_limit required: false type: string - default: list description: 'One of: count, list or minimal' in: query name: actions_format required: false type: string - description: 'A date, null or lastView' in: query name: actions_since required: false type: string - default: all description: 'all or a comma-separated list of: data, date, idMemberCreator or type' in: query name: action_fields required: false type: string - default: none description: 'all or a comma-separated list of: active, admin, deactivated, me or normal' in: query name: memberships required: false type: string - description: ' true or false' in: query name: organization required: false type: string - default: name and displayName description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: organization_fields required: false type: string - default: none description: 'One of: all, closed, none or open' in: query name: lists required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getOrganizationsBoardsByIdOrg() tags: - organization '/organizations/{idOrg}/boards/{filter}': get: operationId: getOrganizationsBoardsByIdOrgByFilter parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getOrganizationsBoardsByIdOrgByFilter() tags: - organization '/organizations/{idOrg}/deltas': get: operationId: getOrganizationsDeltasByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: A valid tag for subscribing in: query name: tags required: true type: string - description: a number from -1 to Infinity in: query name: ixLastUpdate required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getOrganizationsDeltasByIdOrg() tags: - organization '/organizations/{idOrg}/desc': put: operationId: updateOrganizationsDescByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Organizations Desc" to be updated. in: body name: body required: true schema: $ref: '#/definitions/organizations_desc' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsDescByIdOrg() tags: - organization '/organizations/{idOrg}/displayName': put: operationId: updateOrganizationsDisplayNameByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Organizations Display Name" to be updated. in: body name: body required: true schema: $ref: '#/definitions/organizations_displayName' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsDisplayNameByIdOrg() tags: - organization '/organizations/{idOrg}/logo': delete: operationId: deleteOrganizationsLogoByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteOrganizationsLogoByIdOrg() tags: - organization post: operationId: addOrganizationsLogoByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Organizations Logo" to be added. in: body name: body required: true schema: $ref: '#/definitions/organizations_logo' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addOrganizationsLogoByIdOrg() tags: - organization '/organizations/{idOrg}/members': get: operationId: getOrganizationsMembersByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - default: all description: 'One of: admins, all, none, normal or owners' in: query name: filter required: false type: string - default: fullName and username description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: fields required: false type: string - description: true or false ; works for premium organizations only. in: query name: activity required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getOrganizationsMembersByIdOrg() tags: - organization put: operationId: updateOrganizationsMembersByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Organizations Members" to be updated. in: body name: body required: true schema: $ref: '#/definitions/organizations_members' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsMembersByIdOrg() tags: - organization '/organizations/{idOrg}/members/{filter}': get: operationId: getOrganizationsMembersByIdOrgByFilter parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: filter in: path name: filter required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getOrganizationsMembersByIdOrgByFilter() tags: - organization '/organizations/{idOrg}/members/{idMember}': delete: operationId: deleteOrganizationsMembersByIdOrgByIdMember parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: idMember in: path name: idMember required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteOrganizationsMembersByIdOrgByIdMember() tags: - organization put: operationId: updateOrganizationsMembersByIdOrgByIdMember parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: idMember in: path name: idMember required: true type: string - description: Attributes of "Organizations Members" to be updated. in: body name: body required: true schema: $ref: '#/definitions/organizations_members' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsMembersByIdOrgByIdMember() tags: - organization '/organizations/{idOrg}/members/{idMember}/all': delete: operationId: deleteOrganizationsMembersAllByIdOrgByIdMember parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: idMember in: path name: idMember required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteOrganizationsMembersAllByIdOrgByIdMember() tags: - organization '/organizations/{idOrg}/members/{idMember}/cards': get: operationId: getOrganizationsMembersCardsByIdOrgByIdMember parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: idMember in: path name: idMember required: true type: string - description: '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' in: query name: actions required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: attachments required: false type: string - default: all description: 'all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url' in: query name: attachment_fields required: false type: string - description: ' true or false' in: query name: members required: false type: string - default: 'avatarHash, fullName, initials and username' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: ' true or false' in: query name: checkItemStates required: false type: string - default: none description: 'One of: all or none' in: query name: checklists required: false type: string - description: ' true or false' in: query name: board required: false type: string - default: 'name, desc, closed, idOrganization, pinned, url and prefs' description: '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' in: query name: board_fields required: false type: string - description: ' true or false' in: query name: list required: false type: string - default: all description: 'all or a comma-separated list of: closed, idBoard, name, pos or subscribed' in: query name: list_fields required: false type: string - default: visible description: 'One of: all, closed, none, open or visible' in: query name: filter required: false type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getOrganizationsMembersCardsByIdOrgByIdMember() tags: - organization '/organizations/{idOrg}/members/{idMember}/deactivated': put: operationId: updateOrganizationsMembersDeactivatedByIdOrgByIdMember parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: idMember in: path name: idMember required: true type: string - description: Attributes of "Organizations Members Deactivated" to be updated. in: body name: body required: true schema: $ref: '#/definitions/organizations_members_deactivated' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsMembersDeactivatedByIdOrgByIdMember() tags: - organization '/organizations/{idOrg}/membersInvited': get: operationId: getOrganizationsMembersInvitedByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getOrganizationsMembersInvitedByIdOrg() tags: - organization '/organizations/{idOrg}/membersInvited/{field}': get: operationId: getOrganizationsMembersInvitedByIdOrgByField parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getOrganizationsMembersInvitedByIdOrgByField() tags: - organization '/organizations/{idOrg}/memberships': get: operationId: getOrganizationsMembershipsByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - default: all description: 'all or a comma-separated list of: active, admin, deactivated, me or normal' in: query name: filter required: false type: string - description: ' true or false' in: query name: member required: false type: string - default: fullName and username description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getOrganizationsMembershipsByIdOrg() tags: - organization '/organizations/{idOrg}/memberships/{idMembership}': get: operationId: getOrganizationsMembershipsByIdOrgByIdMembership parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: idMembership in: path name: idMembership required: true type: string - description: ' true or false' in: query name: member required: false type: string - default: fullName and username description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getOrganizationsMembershipsByIdOrgByIdMembership() tags: - organization put: operationId: updateOrganizationsMembershipsByIdOrgByIdMembership parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: idMembership in: path name: idMembership required: true type: string - description: Attributes of "Organizations Memberships" to be updated. in: body name: body required: true schema: $ref: '#/definitions/organizations_memberships' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsMembershipsByIdOrgByIdMembership() tags: - organization '/organizations/{idOrg}/name': put: operationId: updateOrganizationsNameByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Organizations Name" to be updated. in: body name: body required: true schema: $ref: '#/definitions/organizations_name' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsNameByIdOrg() tags: - organization '/organizations/{idOrg}/prefs/associatedDomain': delete: operationId: deleteOrganizationsPrefsAssociatedDomainByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteOrganizationsPrefsAssociatedDomainByIdOrg() tags: - organization put: operationId: updateOrganizationsPrefsAssociatedDomainByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Prefs Associated Domain" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_associatedDomain' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsPrefsAssociatedDomainByIdOrg() tags: - organization '/organizations/{idOrg}/prefs/boardVisibilityRestrict/org': put: operationId: updateOrganizationsPrefsBoardVisibilityRestrictOrgByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Prefs Board Visibility Restrict" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_boardVisibilityRestrict' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsPrefsBoardVisibilityRestrictOrgByIdOrg() tags: - organization '/organizations/{idOrg}/prefs/boardVisibilityRestrict/private': put: operationId: updateOrganizationsPrefsBoardVisibilityRestrictPrivateByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Prefs Board Visibility Restrict" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_boardVisibilityRestrict' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsPrefsBoardVisibilityRestrictPrivateByIdOrg() tags: - organization '/organizations/{idOrg}/prefs/boardVisibilityRestrict/public': put: operationId: updateOrganizationsPrefsBoardVisibilityRestrictPublicByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Prefs Board Visibility Restrict" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_boardVisibilityRestrict' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsPrefsBoardVisibilityRestrictPublicByIdOrg() tags: - organization '/organizations/{idOrg}/prefs/externalMembersDisabled': put: operationId: updateOrganizationsPrefsExternalMembersDisabledByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Prefs External Members Disabled" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_externalMembersDisabled' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsPrefsExternalMembersDisabledByIdOrg() tags: - organization '/organizations/{idOrg}/prefs/googleAppsVersion': put: operationId: updateOrganizationsPrefsGoogleAppsVersionByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Prefs Google Apps Version" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_googleAppsVersion' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsPrefsGoogleAppsVersionByIdOrg() tags: - organization '/organizations/{idOrg}/prefs/orgInviteRestrict': delete: operationId: deleteOrganizationsPrefsOrgInviteRestrictByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: An email address with optional expansion tokens in: query name: value required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteOrganizationsPrefsOrgInviteRestrictByIdOrg() tags: - organization put: operationId: updateOrganizationsPrefsOrgInviteRestrictByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Prefs Org Invite Restrict" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_orgInviteRestrict' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsPrefsOrgInviteRestrictByIdOrg() tags: - organization '/organizations/{idOrg}/prefs/permissionLevel': put: operationId: updateOrganizationsPrefsPermissionLevelByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Prefs Permission Level" to be updated. in: body name: body required: true schema: $ref: '#/definitions/prefs_permissionLevel' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsPrefsPermissionLevelByIdOrg() tags: - organization '/organizations/{idOrg}/website': put: operationId: updateOrganizationsWebsiteByIdOrg parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: Attributes of "Organizations Website" to be updated. in: body name: body required: true schema: $ref: '#/definitions/organizations_website' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateOrganizationsWebsiteByIdOrg() tags: - organization '/organizations/{idOrg}/{field}': get: operationId: getOrganizationsByIdOrgByField parameters: - description: idOrg or name in: path name: idOrg required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getOrganizationsByIdOrgByField() tags: - organization /search: get: operationId: getSearch parameters: - description: a string with a length from 1 to 16384 in: query name: query required: true type: string - default: mine description: 'A comma-separated list of objectIds, 24-character hex strings' in: query name: idBoards required: false type: string - description: 'A comma-separated list of objectIds, 24-character hex strings' in: query name: idOrganizations required: true type: string - description: 'A comma-separated list of objectIds, 24-character hex strings' in: query name: idCards required: false type: string - default: all description: 'all or a comma-separated list of: actions, boards, cards, members or organizations' in: query name: modelTypes required: false type: string - default: name and idOrganization description: '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' in: query name: board_fields required: false type: string - default: '10' description: a number from 1 to 1000 in: query name: boards_limit required: false type: string - default: all description: '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' in: query name: card_fields required: false type: string - default: '10' description: a number from 1 to 1000 in: query name: cards_limit required: false type: string - default: '0' description: a number from 0 to 100 in: query name: cards_page required: false type: string - description: ' true or false' in: query name: card_board required: false type: string - description: ' true or false' in: query name: card_list required: false type: string - description: ' true or false' in: query name: card_members required: false type: string - description: ' true or false' in: query name: card_stickers required: false type: string - description: A boolean value or "cover" for only card cover attachments in: query name: card_attachments required: false type: string - default: name and displayName description: 'all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website' in: query name: organization_fields required: false type: string - default: '10' description: a number from 1 to 1000 in: query name: organizations_limit required: false type: string - default: 'avatarHash, fullName, initials, username and confirmed' description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' in: query name: member_fields required: false type: string - default: '10' description: a number from 1 to 1000 in: query name: members_limit required: false type: string - description: ' true or false' in: query name: partial required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getSearch() tags: - search /search/members: get: operationId: getSearchMembers parameters: - description: a string with a length from 1 to 16384 in: query name: query required: true type: string - default: '8' description: a number from 1 to 20 in: query name: limit required: false type: string - description: 'An id, or null' in: query name: idBoard required: false type: string - description: 'An id, or null' in: query name: idOrganization required: false type: string - description: A boolean in: query name: onlyOrgMembers required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getSearchMembers() tags: - search /sessions: post: operationId: addSessions parameters: - description: Attributes of "Sessions" to be added. in: body name: body required: true schema: $ref: '#/definitions/sessions' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addSessions() tags: - session /sessions/socket: get: description: This is the route for WebSocket requests. See the socket API reference for a description of WebSocket usage. operationId: getSessionsSocket parameters: - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getSessionsSocket() tags: - session '/sessions/{idSession}': put: operationId: updateSessionsByIdSession parameters: - description: idSession in: path name: idSession required: true type: string - description: Attributes of "Sessions" to be updated. in: body name: body required: true schema: $ref: '#/definitions/sessions' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateSessionsByIdSession() tags: - session '/sessions/{idSession}/status': put: operationId: updateSessionsStatusByIdSession parameters: - description: idSession in: path name: idSession required: true type: string - description: Attributes of "Sessions Status" to be updated. in: body name: body required: true schema: $ref: '#/definitions/sessions_status' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateSessionsStatusByIdSession() tags: - session '/tokens/{token}': delete: operationId: deleteTokensByToken parameters: - description: token in: path name: token required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteTokensByToken() tags: - token get: operationId: getTokensByToken parameters: - description: token in: path name: token required: true type: string - default: all description: 'all or a comma-separated list of: dateCreated, dateExpires, idMember, identifier or permissions' in: query name: fields required: false type: string - description: ' true or false' in: query name: webhooks required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getTokensByToken() tags: - token '/tokens/{token}/member': get: operationId: getTokensMemberByToken parameters: - description: token in: path name: token required: true type: string - default: all description: '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' in: query name: fields required: false type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getTokensMemberByToken() tags: - token '/tokens/{token}/member/{field}': get: operationId: getTokensMemberByTokenByField parameters: - description: token in: path name: token required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getTokensMemberByTokenByField() tags: - token '/tokens/{token}/webhooks': get: operationId: getTokensWebhooksByToken parameters: - description: token in: path name: token required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getTokensWebhooksByToken() tags: - token post: operationId: addTokensWebhooksByToken parameters: - description: token in: path name: token required: true type: string - description: Attributes of "Tokens Webhooks" to be added. in: body name: body required: true schema: $ref: '#/definitions/tokens_webhooks' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addTokensWebhooksByToken() tags: - token put: operationId: updateTokensWebhooksByToken parameters: - description: token in: path name: token required: true type: string - description: Attributes of "Tokens Webhooks" to be updated. in: body name: body required: true schema: $ref: '#/definitions/tokens_webhooks' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateTokensWebhooksByToken() tags: - token '/tokens/{token}/webhooks/{idWebhook}': delete: operationId: deleteTokensWebhooksByTokenByIdWebhook parameters: - description: token in: path name: token required: true type: string - description: idWebhook in: path name: idWebhook required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteTokensWebhooksByTokenByIdWebhook() tags: - token get: operationId: getTokensWebhooksByTokenByIdWebhook parameters: - description: token in: path name: token required: true type: string - description: idWebhook in: path name: idWebhook required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getTokensWebhooksByTokenByIdWebhook() tags: - token '/tokens/{token}/{field}': get: operationId: getTokensByTokenByField parameters: - description: token in: path name: token required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getTokensByTokenByField() tags: - token '/types/{id}': get: operationId: getTypesById parameters: - description: id in: path name: id required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getTypesById() tags: - type /webhooks: post: operationId: addWebhooks parameters: - description: Attributes of "Webhooks" to be added. in: body name: body required: true schema: $ref: '#/definitions/webhooks' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: addWebhooks() tags: - webhook /webhooks/: put: operationId: updateWebhooks parameters: - description: Attributes of "Webhooks" to be updated. in: body name: body required: true schema: $ref: '#/definitions/webhooks' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateWebhooks() tags: - webhook '/webhooks/{idWebhook}': delete: operationId: deleteWebhooksByIdWebhook parameters: - description: idWebhook in: path name: idWebhook required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: deleteWebhooksByIdWebhook() tags: - webhook get: operationId: getWebhooksByIdWebhook parameters: - description: idWebhook in: path name: idWebhook required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: getWebhooksByIdWebhook() tags: - webhook put: operationId: updateWebhooksByIdWebhook parameters: - description: idWebhook in: path name: idWebhook required: true type: string - description: Attributes of "Webhooks" to be updated. in: body name: body required: true schema: $ref: '#/definitions/webhooks' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateWebhooksByIdWebhook() tags: - webhook '/webhooks/{idWebhook}/active': put: operationId: updateWebhooksActiveByIdWebhook parameters: - description: idWebhook in: path name: idWebhook required: true type: string - description: Attributes of "Webhooks Active" to be updated. in: body name: body required: true schema: $ref: '#/definitions/webhooks_active' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateWebhooksActiveByIdWebhook() tags: - webhook '/webhooks/{idWebhook}/callbackURL': put: operationId: updateWebhooksCallbackURLByIdWebhook parameters: - description: idWebhook in: path name: idWebhook required: true type: string - description: Attributes of "Webhooks Callback Url" to be updated. in: body name: body required: true schema: $ref: '#/definitions/webhooks_callbackURL' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateWebhooksCallbackURLByIdWebhook() tags: - webhook '/webhooks/{idWebhook}/description': put: operationId: updateWebhooksDescriptionByIdWebhook parameters: - description: idWebhook in: path name: idWebhook required: true type: string - description: Attributes of "Webhooks Description" to be updated. in: body name: body required: true schema: $ref: '#/definitions/webhooks_description' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateWebhooksDescriptionByIdWebhook() tags: - webhook '/webhooks/{idWebhook}/idModel': put: operationId: updateWebhooksIdModelByIdWebhook parameters: - description: idWebhook in: path name: idWebhook required: true type: string - description: Attributes of "Webhooks Id Model" to be updated. in: body name: body required: true schema: $ref: '#/definitions/webhooks_idModel' - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection security: - api_key: [] - api_token: [] summary: updateWebhooksIdModelByIdWebhook() tags: - webhook '/webhooks/{idWebhook}/{field}': get: operationId: getWebhooksByIdWebhookByField parameters: - description: idWebhook in: path name: idWebhook required: true type: string - description: field in: path name: field required: true type: string - description: 'Generate your application key' in: query name: key required: true type: string - description: 'Getting a token from a user' in: query name: token required: true type: string responses: '200': description: Success '400': description: Server rejection summary: getWebhooksByIdWebhookByField() tags: - webhook definitions: actions: properties: text: description: a string with a length from 1 to 16384 type: string type: object xml: name: action actions_comments: properties: text: description: a string with a length from 1 to 16384 type: string type: object xml: name: card actions_text: properties: value: description: a string with a length from 1 to 16384 type: string type: object xml: name: action boards: properties: closed: description: ' true or false' type: string desc: description: a string with a length from 0 to 16384 type: string idBoardSource: description: The id of the board to copy into the new board type: string idOrganization: description: The id or name of the organization to add the board to. type: string keepFromSource: description: Components of the source board to copy. type: string labelNames/blue: description: a string with a length from 0 to 16384 type: string labelNames/green: description: a string with a length from 0 to 16384 type: string labelNames/orange: description: a string with a length from 0 to 16384 type: string labelNames/purple: description: a string with a length from 0 to 16384 type: string labelNames/red: description: a string with a length from 0 to 16384 type: string labelNames/yellow: description: a string with a length from 0 to 16384 type: string name: description: a string with a length from 1 to 16384 type: string powerUps: description: 'all or a comma-separated list of: calendar, cardAging, recap or voting' type: string prefs/background: description: 'A standard background name, or the id of a custom background' type: string prefs/calendarFeedEnabled: description: ' true or false' type: string prefs/cardAging: description: 'One of: pirate or regular' type: string prefs/cardCovers: description: ' true or false' type: string prefs/comments: description: 'One of: disabled, members, observers, org or public' type: string prefs/invitations: description: 'One of: admins or members' type: string prefs/permissionLevel: description: 'One of: org, private or public' type: string prefs/selfJoin: description: ' true or false' type: string prefs/voting: description: 'One of: disabled, members, observers, org or public' type: string prefs_background: description: a string with a length from 0 to 16384 type: string prefs_cardAging: description: 'One of: pirate or regular' type: string prefs_cardCovers: description: ' true or false' type: string prefs_comments: description: 'One of: disabled, members, observers, org or public' type: string prefs_invitations: description: 'One of: admins or members' type: string prefs_permissionLevel: description: 'One of: org, private or public' type: string prefs_selfJoin: description: ' true or false' type: string prefs_voting: description: 'One of: disabled, members, observers, org or public' type: string subscribed: description: ' true or false' type: string type: object xml: name: board boards_checklists: properties: name: description: a string with a length from 1 to 16384 type: string type: object xml: name: board boards_closed: properties: value: description: ' true or false' type: string type: object xml: name: board boards_desc: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: board boards_idOrganization: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: board boards_labels: properties: color: description: A valid label color or null type: string name: description: a string with a length from 0 to 16384 type: string type: object xml: name: board boards_lists: properties: name: description: a string with a length from 1 to 16384 type: string pos: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: board boards_members: properties: email: description: An email address type: string fullName: description: A string with a length of at least 1. Cannot begin or end with a space. type: string type: description: 'One of: admin, normal or observer' type: string type: object xml: name: board boards_memberships: properties: member_fields: description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' type: string type: description: 'One of: admin, normal or observer' type: string type: object xml: name: board boards_name: properties: value: description: a string with a length from 1 to 16384 type: string type: object xml: name: board boards_powerUps: properties: value: description: 'One of: calendar, cardAging, recap or voting' type: string type: object xml: name: board boards_subscribed: properties: value: description: ' true or false' type: string type: object xml: name: board cards: properties: closed: description: ' true or false' type: string desc: description: a string with a length from 0 to 16384 type: string due: description: 'A date, or null' type: string fileSource: description: A file type: string idAttachmentCover: description: 'Id of the image attachment of this card to use as its cover, or null for no cover' type: string idBoard: description: id of the board the card should be moved to type: string idCardSource: description: The id of the card to copy into a new card. type: string idLabels: description: 'A comma-separated list of objectIds, 24-character hex strings' type: string idList: description: id of the list that the card should be added to type: string idMembers: description: 'A comma-separated list of objectIds, 24-character hex strings' type: string keepFromSource: description: Properties of the card to copy over from the source. type: string labels: description: 'all or a comma-separated list of: blue, green, orange, purple, red or yellow' type: string name: 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.' type: string pos: description: 'A position. top , bottom , or a positive number.' type: string subscribed: description: ' true or false' type: string urlSource: description: 'A URL starting with http:// or https:// or null' type: string type: object xml: name: card cards_actions_comments: properties: text: description: a string with a length from 1 to 16384 type: string type: object xml: name: card cards_attachments: properties: file: description: A file type: string mimeType: description: a string with a length from 0 to 256 type: string name: description: a string with a length from 0 to 256 type: string url: description: 'A URL starting with http:// or https:// or null' type: string type: object xml: name: card cards_checklist_checkItem: properties: name: description: a string with a length from 1 to 16384 type: string pos: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: card cards_checklist_checkItem_name: properties: value: description: a string with a length from 1 to 16384 type: string type: object xml: name: card cards_checklist_checkItem_pos: properties: value: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: card cards_checklist_checkItem_state: properties: value: description: 'One of: complete, false, incomplete or true' type: string type: object xml: name: card cards_checklist_idChecklistCurrent_checkItem: properties: idChecklist: description: 'An id, or null' type: string name: description: a string with a length from 1 to 16384 type: string pos: description: 'A position. top , bottom , or a positive number.' type: string state: description: 'One of: complete, false, incomplete or true' type: string type: object xml: name: card cards_checklists: properties: idChecklistSource: description: The id of the source checklist to copy into a new checklist. type: string name: description: a string with a length from 0 to 16384 type: string value: description: 'The id of the checklist to add to the card, or null to create a new one.' type: string type: object xml: name: card cards_closed: properties: value: description: ' true or false' type: string type: object xml: name: card cards_desc: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: card cards_due: properties: value: description: 'A date, or null' type: string type: object xml: name: card cards_idAttachmentCover: properties: value: description: 'Id of the image attachment of this card to use as its cover, or null for no cover' type: string type: object xml: name: card cards_idBoard: properties: idList: description: id of the list that the card should be moved to on the new board type: string value: description: id of the board the card should be moved to type: string type: object xml: name: card cards_idLabels: properties: value: description: The id of the label to add type: string type: object xml: name: card cards_idList: properties: value: description: id of the list the card should be moved to type: string type: object xml: name: card cards_idMembers: properties: value: description: The id of the member to add to the card type: string type: object xml: name: card cards_labels: properties: color: description: A valid label color or null type: string name: description: a string with a length from 0 to 16384 type: string value: description: 'all or a comma-separated list of: blue, green, orange, purple, red or yellow' type: string type: object xml: name: card cards_membersVoted: properties: value: description: 'The id of the member to vote 'yes' on the card' type: string type: object xml: name: card cards_name: properties: value: description: a string with a length from 1 to 16384 type: string type: object xml: name: card cards_pos: properties: value: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: card cards_stickers: properties: image: description: a string with a length from 0 to 16384 type: string left: description: undefined type: string rotate: description: undefined type: string top: description: undefined type: string zIndex: description: 'Valid Z values for stickers, must be an integer' type: string type: object xml: name: card cards_subscribed: properties: value: description: ' true or false' type: string type: object xml: name: card checklists: properties: idBoard: description: id of the board that the checklist should be added to type: string idCard: description: id of the card that the checklist should be added to type: string idChecklistSource: description: The id of the source checklist to copy into a new checklist. type: string name: description: a string with a length from 0 to 16384 type: string pos: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: checklist checklists_checkItems: properties: checked: description: ' true or false' type: string name: description: a string with a length from 1 to 16384 type: string pos: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: checklist checklists_idCard: properties: value: description: The id of the card that the checklist is on type: string type: object xml: name: checklist checklists_name: properties: value: description: a string with a length from 1 to 16384 type: string type: object xml: name: checklist checklists_pos: properties: value: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: checklist labelNames_blue: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: board labelNames_green: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: board labelNames_orange: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: board labelNames_purple: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: board labelNames_red: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: board labelNames_yellow: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: board labels: properties: color: description: A valid label color or null type: string idBoard: description: An id type: string name: description: a string with a length from 0 to 16384 type: string type: object xml: name: label labels_color: properties: value: description: A valid label color or null type: string type: object xml: name: label labels_name: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: label lists: properties: closed: description: ' true or false' type: string idBoard: description: id of the board that the list should be added to type: string idListSource: description: The id of the list to copy into a new list. type: string name: description: a string with a length from 1 to 16384 type: string pos: description: 'A position. top , bottom , or a positive number.' type: string subscribed: description: ' true or false' type: string type: object xml: name: list lists_cards: properties: desc: description: a string with a length from 0 to 16384 type: string due: description: 'A date, or null' type: string idMembers: description: 'A comma-separated list of objectIds, 24-character hex strings' type: string labels: description: 'all or a comma-separated list of: blue, green, orange, purple, red or yellow' type: string name: description: a string with a length from 1 to 16384 type: string type: object xml: name: list lists_closed: properties: value: description: ' true or false' type: string type: object xml: name: list lists_idBoard: properties: pos: description: position of the list on the new board type: string value: description: id of the board the list should be moved to type: string type: object xml: name: list lists_moveAllCards: properties: idBoard: description: id of the board that the cards should be moved to type: string type: object xml: name: list lists_name: properties: value: description: a string with a length from 1 to 16384 type: string type: object xml: name: list lists_pos: properties: value: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: list lists_subscribed: properties: value: description: ' true or false' type: string type: object xml: name: list members: properties: avatarSource: description: 'One of: gravatar, none or upload' type: string bio: description: a string with a length from 0 to 16384 type: string fullName: description: A string with a length of at least 1. Cannot begin or end with a space. type: string initials: description: A string with a length from 1 to 4. Cannot begin or end with a space type: string prefs/colorBlind: description: ' true or false' type: string prefs/locale: description: a string with a length from 0 to 255 type: string prefs/minutesBetweenSummaries: description: '-1 (disabled), 1 or 60' type: string username: description: 'A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique.' type: string type: object xml: name: member members_avatar: properties: file: description: A file type: string type: object xml: name: member members_avatarSource: properties: value: description: 'One of: gravatar, none or upload' type: string type: object xml: name: member members_bio: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: member members_boardBackgrounds: properties: brightness: description: 'One of: dark, light or unknown' type: string file: description: A file type: string tile: description: ' true or false' type: string type: object xml: name: member members_boardStars: properties: idBoard: description: The id of the board to star type: string pos: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: member members_boardStars_idBoard: properties: value: description: An id type: string type: object xml: name: member members_boardStars_pos: properties: value: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: member members_customBoardBackgrounds: properties: brightness: description: 'One of: dark, light or unknown' type: string file: description: A file type: string tile: description: ' true or false' type: string type: object xml: name: member members_customEmoji: properties: file: description: A file type: string name: description: a string with a length from 2 to 64 type: string type: object xml: name: member members_customStickers: properties: file: description: A file type: string type: object xml: name: member members_fullName: properties: value: description: A string with a length of at least 1. Cannot begin or end with a space. type: string type: object xml: name: member members_initials: properties: value: description: A string with a length from 1 to 4. Cannot begin or end with a space type: string type: object xml: name: member members_oneTimeMessagesDismissed: properties: value: description: Type of message dismissed type: string type: object xml: name: member members_savedSearches: properties: name: description: A non-empty string with at least one non-space character type: string pos: description: 'A position. top , bottom , or a positive number.' type: string query: description: a string with a length from 1 to 16384 type: string type: object xml: name: member members_savedSearches_name: properties: value: description: A non-empty string with at least one non-space character type: string type: object xml: name: member members_savedSearches_pos: properties: value: description: 'A position. top , bottom , or a positive number.' type: string type: object xml: name: member members_savedSearches_query: properties: value: description: a string with a length from 1 to 16384 type: string type: object xml: name: member members_username: properties: value: description: 'A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique.' type: string type: object xml: name: member myPrefs_emailPosition: properties: value: description: 'One of: bottom or top' type: string type: object xml: name: board myPrefs_idEmailList: properties: value: description: An id type: string type: object xml: name: board myPrefs_showListGuide: properties: value: description: ' true or false' type: string type: object xml: name: board myPrefs_showSidebar: properties: value: description: ' true or false' type: string type: object xml: name: board myPrefs_showSidebarActivity: properties: value: description: ' true or false' type: string type: object xml: name: board myPrefs_showSidebarBoardActions: properties: value: description: ' true or false' type: string type: object xml: name: board myPrefs_showSidebarMembers: properties: value: description: ' true or false' type: string type: object xml: name: board notifications: properties: unread: description: ' true or false' type: string type: object xml: name: notification notifications_unread: properties: value: description: ' true or false' type: string type: object xml: name: notification organizations: properties: desc: description: a string with a length from 0 to 16384 type: string displayName: description: A string with a length of at least 1. Cannot begin or end with a space. type: string name: description: a string with a length from 0 to 16384 type: string prefs/associatedDomain: description: The google apps domain to link this org to. type: string prefs/boardVisibilityRestrict/org: description: 'One of: admin, none or org' type: string prefs/boardVisibilityRestrict/private: description: 'One of: admin, none or org' type: string prefs/boardVisibilityRestrict/public: description: 'One of: admin, none or org' type: string prefs/externalMembersDisabled: description: ' true or false' type: string prefs/googleAppsVersion: description: a number from 1 to 2 type: string prefs/orgInviteRestrict: description: An email address with optional expansion tokens type: string prefs/permissionLevel: description: 'One of: private or public' type: string website: description: 'A URL starting with http:// or https:// or null' type: string type: object xml: name: organization organizations_desc: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: organization organizations_displayName: properties: value: description: A string with a length of at least 1. Cannot begin or end with a space. type: string type: object xml: name: organization organizations_logo: properties: file: description: A file type: string type: object xml: name: organization organizations_members: properties: email: description: An email address type: string fullName: description: A string with a length of at least 1. Cannot begin or end with a space. type: string type: description: 'One of: admin, normal or observer' type: string type: object xml: name: organization organizations_members_deactivated: properties: value: description: ' true or false' type: string type: object xml: name: organization organizations_memberships: properties: member_fields: description: 'all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username' type: string type: description: 'One of: admin, normal or observer' type: string type: object xml: name: organization organizations_name: properties: value: description: 'A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique.' type: string type: object xml: name: organization organizations_website: properties: value: description: 'A URL starting with http:// or https:// or null' type: string type: object xml: name: organization prefs_associatedDomain: properties: value: description: The google apps domain to link this org to. type: string type: object xml: name: organization prefs_background: properties: value: description: 'A standard background name, or the id of a custom background' type: string type: object xml: name: board prefs_boardVisibilityRestrict: properties: value: description: 'One of: admin, none or org' type: string type: object xml: name: organization prefs_calendarFeedEnabled: properties: value: description: ' true or false' type: string type: object xml: name: board prefs_cardAging: properties: value: description: 'One of: pirate or regular' type: string type: object xml: name: board prefs_cardCovers: properties: value: description: ' true or false' type: string type: object xml: name: board prefs_colorBlind: properties: value: description: ' true or false' type: string type: object xml: name: member prefs_comments: properties: value: description: 'One of: disabled, members, observers, org or public' type: string type: object xml: name: board prefs_externalMembersDisabled: properties: value: description: ' true or false' type: string type: object xml: name: organization prefs_googleAppsVersion: properties: value: description: a number from 1 to 2 type: string type: object xml: name: organization prefs_invitations: properties: value: description: 'One of: admins or members' type: string type: object xml: name: board prefs_locale: properties: value: description: a string with a length from 0 to 255 type: string type: object xml: name: member prefs_minutesBetweenSummaries: properties: value: description: '-1 (disabled), 1 or 60' type: string type: object xml: name: member prefs_orgInviteRestrict: properties: value: description: An email address with optional expansion tokens type: string type: object xml: name: organization prefs_permissionLevel: properties: value: description: 'One of: private or public' type: string type: object xml: name: board prefs_selfJoin: properties: value: description: ' true or false' type: string type: object xml: name: board prefs_voting: properties: value: description: 'One of: disabled, members, observers, org or public' type: string type: object xml: name: board sessions: properties: idBoard: description: 'The id of the board you're viewing. Boards with no viewers will not get updates about members' statuses.' type: string status: description: 'One of: active, disconnected or idle' type: string type: object xml: name: session sessions_status: properties: value: description: 'One of: active, disconnected or idle' type: string type: object xml: name: session tokens_webhooks: properties: callbackURL: description: A valid URL that is reachable with a HEAD request type: string description: description: a string with a length from 0 to 16384 type: string idModel: description: id of the model to be monitored type: string type: object xml: name: token webhooks: properties: active: description: ' true or false' type: string callbackURL: description: A valid URL that is reachable with a HEAD request type: string description: description: a string with a length from 0 to 16384 type: string idModel: description: id of the model that should be hooked type: string type: object xml: name: webhook webhooks_active: properties: value: description: ' true or false' type: string type: object xml: name: webhook webhooks_callbackURL: properties: value: description: A valid URL that is reachable with a HEAD request type: string type: object xml: name: webhook webhooks_description: properties: value: description: a string with a length from 0 to 16384 type: string type: object xml: name: webhook webhooks_idModel: properties: value: description: id of the model to be monitored type: string type: object xml: name: webhook