Visual project management and collaboration
developer.atlassian.com/cloud/trello/rest ↗Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://trello.com/1
/actions/{idAction}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| display | query | optional | string | true or false |
| entities | query | optional | string | true or false |
| fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| memberCreator | query | optional | string | true or false |
| memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /actions/{idAction}
/actions/{idAction}/board
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
GET /actions/{idAction}/board
/actions/{idAction}/board/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| field | path | required | string | field |
GET /actions/{idAction}/board/{field}
/actions/{idAction}/card
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
GET /actions/{idAction}/card
/actions/{idAction}/card/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| field | path | required | string | field |
GET /actions/{idAction}/card/{field}
/actions/{idAction}/display
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
GET /actions/{idAction}/display
/actions/{idAction}/entities
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
GET /actions/{idAction}/entities
/actions/{idAction}/list
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| fields | query | optional | string | all or a comma-separated list of: closed, idBoard, name, pos or subscribed |
GET /actions/{idAction}/list
/actions/{idAction}/list/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| field | path | required | string | field |
GET /actions/{idAction}/list/{field}
/actions/{idAction}/member
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username |
GET /actions/{idAction}/member
/actions/{idAction}/member/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| field | path | required | string | field |
GET /actions/{idAction}/member/{field}
/actions/{idAction}/memberCreator
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username |
GET /actions/{idAction}/memberCreator
/actions/{idAction}/memberCreator/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| field | path | required | string | field |
GET /actions/{idAction}/memberCreator/{field}
/actions/{idAction}/organization
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
GET /actions/{idAction}/organization
/actions/{idAction}/organization/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| field | path | required | string | field |
GET /actions/{idAction}/organization/{field}
/actions/{idAction}/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
| field | path | required | string | field |
GET /actions/{idAction}/{field}
/batch
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| urls | query | required | string | list of API v1 GET routes, not including the version prefix |
GET /batch
/boards/{idBoard}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| actions_entities | query | optional | string | true or false |
| actions_display | query | optional | string | true or false |
| actions_format | query | optional | string | One of: count, list or minimal |
| actions_since | query | optional | string | A date, null or lastView |
| actions_limit | query | optional | string | a number from 0 to 1000 |
| action_fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| action_member | query | optional | string | true or false |
| action_member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| action_memberCreator | query | optional | string | true or false |
| action_memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| cards | query | optional | string | One of: all, closed, none, open or visible |
| card_fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
| card_attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| card_attachment_fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| card_checklists | query | optional | string | One of: all or none |
| card_stickers | query | optional | string | true or false |
| boardStars | query | optional | string | One of: mine or none |
| labels | query | optional | string | One of: all or none |
| label_fields | query | optional | string | all or a comma-separated list of: color, idBoard, name or uses |
| labels_limit | query | optional | string | a number from 0 to 1000 |
| lists | query | optional | string | One of: all, closed, none or open |
| list_fields | query | optional | string | all or a comma-separated list of: closed, idBoard, name, pos or subscribed |
| memberships | query | optional | string | all or a comma-separated list of: active, admin, deactivated, me or normal |
| memberships_member | query | optional | string | true or false |
| memberships_member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| members | query | optional | string | One of: admins, all, none, normal or owners |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| membersInvited | query | optional | string | One of: admins, all, none, normal or owners |
| membersInvited_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| checklists | query | optional | string | One of: all or none |
| checklist_fields | query | optional | string | all or a comma-separated list of: idBoard, idCard, name or pos |
| organization | query | optional | string | true or false |
| organization_fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
| organization_memberships | query | optional | string | all or a comma-separated list of: active, admin, deactivated, me or normal |
| myPrefs | query | optional | string | true or false |
| fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
GET /boards/{idBoard}
/boards/{idBoard}/actions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| entities | query | optional | string | true or false |
| display | query | optional | string | true or false |
| filter | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| limit | query | optional | string | a number from 0 to 1000 |
| format | query | optional | string | One of: count, list or minimal |
| since | query | optional | string | A date, null or lastView |
| before | query | optional | string | A date, or null |
| page | query | optional | string | Page * limit must be less than 1000 |
| idModels | query | optional | string | Only return actions related to these model ids |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| memberCreator | query | optional | string | true or false |
| memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /boards/{idBoard}/actions
/boards/{idBoard}/boardStars
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| filter | query | optional | string | One of: mine or none |
GET /boards/{idBoard}/boardStars
/boards/{idBoard}/cards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| attachment_fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| stickers | query | optional | string | true or false |
| members | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| checkItemStates | query | optional | string | true or false |
| checklists | query | optional | string | One of: all or none |
| limit | query | optional | string | a number from 1 to 1000 |
| since | query | optional | string | A date, or null |
| before | query | optional | string | A date, or null |
| filter | query | optional | string | One of: all, closed, none, open or visible |
| fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
GET /boards/{idBoard}/cards
/boards/{idBoard}/cards/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| filter | path | required | string | filter |
GET /boards/{idBoard}/cards/{filter}
/boards/{idBoard}/cards/{idCard}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| idCard | path | required | string | idCard |
| attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| attachment_fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| actions_entities | query | optional | string | true or false |
| actions_display | query | optional | string | true or false |
| actions_limit | query | optional | string | a number from 0 to 1000 |
| action_fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| action_memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| members | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| checkItemStates | query | optional | string | true or false |
| checkItemState_fields | query | optional | string | all or a comma-separated list of: idCheckItem or state |
| labels | query | optional | string | true or false |
| checklists | query | optional | string | One of: all or none |
| checklist_fields | query | optional | string | all or a comma-separated list of: idBoard, idCard, name or pos |
| fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
GET /boards/{idBoard}/cards/{idCard}
/boards/{idBoard}/checklists
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| cards | query | optional | string | One of: all, closed, none, open or visible |
| card_fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
| checkItems | query | optional | string | One of: all or none |
| checkItem_fields | query | optional | string | all or a comma-separated list of: name, nameData, pos, state or type |
| filter | query | optional | string | One of: all or none |
| fields | query | optional | string | all or a comma-separated list of: idBoard, idCard, name or pos |
GET /boards/{idBoard}/checklists
/boards/{idBoard}/deltas
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| tags | query | required | string | A valid tag for subscribing |
| ixLastUpdate | query | required | string | a number from -1 to Infinity |
GET /boards/{idBoard}/deltas
/boards/{idBoard}/labels
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| fields | query | optional | string | all or a comma-separated list of: color, idBoard, name or uses |
| limit | query | optional | string | a number from 0 to 1000 |
GET /boards/{idBoard}/labels
/boards/{idBoard}/labels/{idLabel}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| idLabel | path | required | string | idLabel |
| fields | query | optional | string | all or a comma-separated list of: color, idBoard, name or uses |
GET /boards/{idBoard}/labels/{idLabel}
/boards/{idBoard}/lists
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| cards | query | optional | string | One of: all, closed, none, open or visible |
| card_fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
| filter | query | optional | string | One of: all, closed, none or open |
| fields | query | optional | string | all or a comma-separated list of: closed, idBoard, name, pos or subscribed |
GET /boards/{idBoard}/lists
/boards/{idBoard}/lists/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| filter | path | required | string | filter |
GET /boards/{idBoard}/lists/{filter}
/boards/{idBoard}/members
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| filter | query | optional | string | One of: admins, all, none, normal or owners |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| activity | query | optional | string | true or false ; works for premium organizations only. |
GET /boards/{idBoard}/members
/boards/{idBoard}/members/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| filter | path | required | string | filter |
GET /boards/{idBoard}/members/{filter}
/boards/{idBoard}/members/{idMember}/cards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| idMember | path | required | string | idMember |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| attachment_fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| members | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| checkItemStates | query | optional | string | true or false |
| checklists | query | optional | string | One of: all or none |
| board | query | optional | string | true or false |
| board_fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| list | query | optional | string | true or false |
| list_fields | query | optional | string | all or a comma-separated list of: closed, idBoard, name, pos or subscribed |
| filter | query | optional | string | One of: all, closed, none, open or visible |
| fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
GET /boards/{idBoard}/members/{idMember}/cards
/boards/{idBoard}/membersInvited
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username |
GET /boards/{idBoard}/membersInvited
/boards/{idBoard}/membersInvited/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| field | path | required | string | field |
GET /boards/{idBoard}/membersInvited/{field}
/boards/{idBoard}/memberships
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| filter | query | optional | string | all or a comma-separated list of: active, admin, deactivated, me or normal |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /boards/{idBoard}/memberships
/boards/{idBoard}/memberships/{idMembership}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| idMembership | path | required | string | idMembership |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /boards/{idBoard}/memberships/{idMembership}
/boards/{idBoard}/myPrefs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
GET /boards/{idBoard}/myPrefs
/boards/{idBoard}/organization
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
GET /boards/{idBoard}/organization
/boards/{idBoard}/organization/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| field | path | required | string | field |
GET /boards/{idBoard}/organization/{field}
/boards/{idBoard}/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| field | path | required | string | field |
GET /boards/{idBoard}/{field}
/cards/{idCard}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| actions_entities | query | optional | string | true or false |
| actions_display | query | optional | string | true or false |
| actions_limit | query | optional | string | a number from 0 to 1000 |
| action_fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| action_memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| attachment_fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| members | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| membersVoted | query | optional | string | true or false |
| memberVoted_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| checkItemStates | query | optional | string | true or false |
| checkItemState_fields | query | optional | string | all or a comma-separated list of: idCheckItem or state |
| checklists | query | optional | string | One of: all or none |
| checklist_fields | query | optional | string | all or a comma-separated list of: idBoard, idCard, name or pos |
| board | query | optional | string | true or false |
| board_fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| list | query | optional | string | true or false |
| list_fields | query | optional | string | all or a comma-separated list of: closed, idBoard, name, pos or subscribed |
| stickers | query | optional | string | true or false |
| sticker_fields | query | optional | string | all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex |
| fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
GET /cards/{idCard}
/cards/{idCard}/actions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| entities | query | optional | string | true or false |
| display | query | optional | string | true or false |
| filter | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| limit | query | optional | string | a number from 0 to 1000 |
| format | query | optional | string | One of: count, list or minimal |
| since | query | optional | string | A date, null or lastView |
| before | query | optional | string | A date, or null |
| page | query | optional | string | Page * limit must be less than 1000 |
| idModels | query | optional | string | Only return actions related to these model ids |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| memberCreator | query | optional | string | true or false |
| memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /cards/{idCard}/actions
/cards/{idCard}/attachments
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| filter | query | optional | string | A boolean value or "cover" for only card cover attachments |
GET /cards/{idCard}/attachments
/cards/{idCard}/attachments/{idAttachment}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| idAttachment | path | required | string | idAttachment |
| fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
GET /cards/{idCard}/attachments/{idAttachment}
/cards/{idCard}/board
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
GET /cards/{idCard}/board
/cards/{idCard}/board/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| field | path | required | string | field |
GET /cards/{idCard}/board/{field}
/cards/{idCard}/checkItemStates
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| fields | query | optional | string | all or a comma-separated list of: idCheckItem or state |
GET /cards/{idCard}/checkItemStates
/cards/{idCard}/checklists
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| cards | query | optional | string | One of: all, closed, none, open or visible |
| card_fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
| checkItems | query | optional | string | One of: all or none |
| checkItem_fields | query | optional | string | all or a comma-separated list of: name, nameData, pos, state or type |
| filter | query | optional | string | One of: all or none |
| fields | query | optional | string | all or a comma-separated list of: idBoard, idCard, name or pos |
GET /cards/{idCard}/checklists
/cards/{idCard}/list
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| fields | query | optional | string | all or a comma-separated list of: closed, idBoard, name, pos or subscribed |
GET /cards/{idCard}/list
/cards/{idCard}/list/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| field | path | required | string | field |
GET /cards/{idCard}/list/{field}
/cards/{idCard}/members
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /cards/{idCard}/members
/cards/{idCard}/membersVoted
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /cards/{idCard}/membersVoted
/cards/{idCard}/stickers
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| fields | query | optional | string | all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex |
GET /cards/{idCard}/stickers
/cards/{idCard}/stickers/{idSticker}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| idSticker | path | required | string | idSticker |
| fields | query | optional | string | all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex |
GET /cards/{idCard}/stickers/{idSticker}
/cards/{idCard}/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| field | path | required | string | field |
GET /cards/{idCard}/{field}
/checklists/{idChecklist}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
| cards | query | optional | string | One of: all, closed, none, open or visible |
| card_fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
| checkItems | query | optional | string | One of: all or none |
| checkItem_fields | query | optional | string | all or a comma-separated list of: name, nameData, pos, state or type |
| fields | query | optional | string | all or a comma-separated list of: idBoard, idCard, name or pos |
GET /checklists/{idChecklist}
/checklists/{idChecklist}/board
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
| fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
GET /checklists/{idChecklist}/board
/checklists/{idChecklist}/board/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
| field | path | required | string | field |
GET /checklists/{idChecklist}/board/{field}
/checklists/{idChecklist}/cards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| attachment_fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| stickers | query | optional | string | true or false |
| members | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| checkItemStates | query | optional | string | true or false |
| checklists | query | optional | string | One of: all or none |
| limit | query | optional | string | a number from 1 to 1000 |
| since | query | optional | string | A date, or null |
| before | query | optional | string | A date, or null |
| filter | query | optional | string | One of: all, closed, none or open |
| fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
GET /checklists/{idChecklist}/cards
/checklists/{idChecklist}/cards/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
| filter | path | required | string | filter |
GET /checklists/{idChecklist}/cards/{filter}
/checklists/{idChecklist}/checkItems
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
| filter | query | optional | string | One of: all or none |
| fields | query | optional | string | all or a comma-separated list of: name, nameData, pos, state or type |
GET /checklists/{idChecklist}/checkItems
/checklists/{idChecklist}/checkItems/{idCheckItem}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
| idCheckItem | path | required | string | idCheckItem |
| fields | query | optional | string | all or a comma-separated list of: name, nameData, pos, state or type |
GET /checklists/{idChecklist}/checkItems/{idCheckItem}
/checklists/{idChecklist}/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
| field | path | required | string | field |
GET /checklists/{idChecklist}/{field}
/labels/{idLabel}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idLabel | path | required | string | idLabel |
| fields | query | optional | string | all or a comma-separated list of: color, idBoard, name or uses |
GET /labels/{idLabel}
/labels/{idLabel}/board
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idLabel | path | required | string | idLabel |
| fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
GET /labels/{idLabel}/board
/labels/{idLabel}/board/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idLabel | path | required | string | idLabel |
| field | path | required | string | field |
GET /labels/{idLabel}/board/{field}
/lists/{idList}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
| cards | query | optional | string | One of: all, closed, none or open |
| card_fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
| board | query | optional | string | true or false |
| board_fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| fields | query | optional | string | all or a comma-separated list of: closed, idBoard, name, pos or subscribed |
GET /lists/{idList}
/lists/{idList}/actions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
| entities | query | optional | string | true or false |
| display | query | optional | string | true or false |
| filter | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| limit | query | optional | string | a number from 0 to 1000 |
| format | query | optional | string | One of: count, list or minimal |
| since | query | optional | string | A date, null or lastView |
| before | query | optional | string | A date, or null |
| page | query | optional | string | Page * limit must be less than 1000 |
| idModels | query | optional | string | Only return actions related to these model ids |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| memberCreator | query | optional | string | true or false |
| memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /lists/{idList}/actions
/lists/{idList}/board
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
| fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
GET /lists/{idList}/board
/lists/{idList}/board/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
| field | path | required | string | field |
GET /lists/{idList}/board/{field}
/lists/{idList}/cards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| attachment_fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| stickers | query | optional | string | true or false |
| members | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| checkItemStates | query | optional | string | true or false |
| checklists | query | optional | string | One of: all or none |
| limit | query | optional | string | a number from 1 to 1000 |
| since | query | optional | string | A date, or null |
| before | query | optional | string | A date, or null |
| filter | query | optional | string | One of: all, closed, none or open |
| fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
GET /lists/{idList}/cards
/lists/{idList}/cards/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
| filter | path | required | string | filter |
GET /lists/{idList}/cards/{filter}
/lists/{idList}/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
| field | path | required | string | field |
GET /lists/{idList}/{field}
/members/{idMember}
If you specify 'me' as the username, this call will respond as if you had supplied the username associated with the supplied token
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| actions_entities | query | optional | string | true or false |
| actions_display | query | optional | string | true or false |
| actions_limit | query | optional | string | a number from 0 to 1000 |
| action_fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| action_since | query | optional | string | A date, null or lastView |
| action_before | query | optional | string | A date, or null |
| cards | query | optional | string | One of: all, closed, none, open or visible |
| card_fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
| card_members | query | optional | string | true or false |
| card_member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| card_attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| card_attachment_fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| card_stickers | query | optional | string | true or false |
| boards | query | optional | string | all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned |
| board_fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| board_actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| board_actions_entities | query | optional | string | true or false |
| board_actions_display | query | optional | string | true or false |
| board_actions_format | query | optional | string | One of: count, list or minimal |
| board_actions_since | query | optional | string | A date, null or lastView |
| board_actions_limit | query | optional | string | a number from 0 to 1000 |
| board_action_fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| board_lists | query | optional | string | One of: all, closed, none or open |
| board_memberships | query | optional | string | all or a comma-separated list of: active, admin, deactivated, me or normal |
| board_organization | query | optional | string | true or false |
| board_organization_fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
| boardsInvited | query | optional | string | all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned |
| boardsInvited_fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| boardStars | query | optional | string | true or false |
| savedSearches | query | optional | string | true or false |
| organizations | query | optional | string | One of: all, members, none or public |
| organization_fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
| organization_paid_account | query | optional | string | true or false |
| organizationsInvited | query | optional | string | One of: all, members, none or public |
| organizationsInvited_fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
| notifications | query | optional | string | all or a comma-separated list of: addAdminToBoard, addAdminToOrganization, addedAttachmentToCard, addedMemberToCard, addedToBoard, addedToCard, addedToOrganization, cardDueSoon, changeCard, closeBoard, commentCard, createdCard, declinedInvitationToBoard, declinedInvitationToOrganization, invitedToBoard, invitedToOrganization, makeAdminOfBoard, makeAdminOfOrganization, memberJoinedTrello, mentionedOnCard, removedFromBoard, removedFromCard, removedFromOrganization, removedMemberFromCard, unconfirmedInvitedToBoard, unconfirmedInvitedToOrganization or updateCheckItemStateOnCard |
| notifications_entities | query | optional | string | true or false |
| notifications_display | query | optional | string | true or false |
| notifications_limit | query | optional | string | a number from 1 to 1000 |
| notification_fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator, type or unread |
| notification_memberCreator | query | optional | string | true or false |
| notification_memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| notification_before | query | optional | string | An id, or null |
| notification_since | query | optional | string | An id, or null |
| tokens | query | optional | string | One of: all or none |
| paid_account | query | optional | string | true or false |
| boardBackgrounds | query | optional | string | One of: all, custom, default, none or premium |
| customBoardBackgrounds | query | optional | string | One of: all or none |
| customStickers | query | optional | string | One of: all or none |
| customEmoji | query | optional | string | One of: all or none |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username |
GET /members/{idMember}
/members/{idMember}/actions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| entities | query | optional | string | true or false |
| display | query | optional | string | true or false |
| filter | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| limit | query | optional | string | a number from 0 to 1000 |
| format | query | optional | string | One of: count, list or minimal |
| since | query | optional | string | A date, null or lastView |
| before | query | optional | string | A date, or null |
| page | query | optional | string | Page * limit must be less than 1000 |
| idModels | query | optional | string | Only return actions related to these model ids |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| memberCreator | query | optional | string | true or false |
| memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /members/{idMember}/actions
/members/{idMember}/boardBackgrounds
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | query | optional | string | One of: all, custom, default, none or premium |
GET /members/{idMember}/boardBackgrounds
/members/{idMember}/boardBackgrounds/{idBoardBackground}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idBoardBackground | path | required | string | idBoardBackground |
| fields | query | optional | string | all or a comma-separated list of: brightness, fullSizeUrl, scaled or tile |
GET /members/{idMember}/boardBackgrounds/{idBoardBackground}
/members/{idMember}/boardStars
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
GET /members/{idMember}/boardStars
/members/{idMember}/boardStars/{idBoardStar}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idBoardStar | path | required | string | idBoardStar |
GET /members/{idMember}/boardStars/{idBoardStar}
/members/{idMember}/boards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | query | optional | string | all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned |
| fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| actions_entities | query | optional | string | true or false |
| actions_limit | query | optional | string | a number from 0 to 1000 |
| actions_format | query | optional | string | One of: count, list or minimal |
| actions_since | query | optional | string | A date, null or lastView |
| action_fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| memberships | query | optional | string | all or a comma-separated list of: active, admin, deactivated, me or normal |
| organization | query | optional | string | true or false |
| organization_fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
| lists | query | optional | string | One of: all, closed, none or open |
GET /members/{idMember}/boards
/members/{idMember}/boards/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | path | required | string | filter |
GET /members/{idMember}/boards/{filter}
/members/{idMember}/boardsInvited
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
GET /members/{idMember}/boardsInvited
/members/{idMember}/boardsInvited/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| field | path | required | string | field |
GET /members/{idMember}/boardsInvited/{field}
/members/{idMember}/cards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| attachment_fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| stickers | query | optional | string | true or false |
| members | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| checkItemStates | query | optional | string | true or false |
| checklists | query | optional | string | One of: all or none |
| limit | query | optional | string | a number from 1 to 1000 |
| since | query | optional | string | A date, or null |
| before | query | optional | string | A date, or null |
| filter | query | optional | string | One of: all, closed, none, open or visible |
| fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
GET /members/{idMember}/cards
/members/{idMember}/cards/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | path | required | string | filter |
GET /members/{idMember}/cards/{filter}
/members/{idMember}/customBoardBackgrounds
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | query | optional | string | One of: all or none |
GET /members/{idMember}/customBoardBackgrounds
/members/{idMember}/customBoardBackgrounds/{idBoardBackground}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idBoardBackground | path | required | string | idBoardBackground |
| fields | query | optional | string | all or a comma-separated list of: brightness, fullSizeUrl, scaled or tile |
GET /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
/members/{idMember}/customEmoji
This gets the list of all of the user’s uploaded emoji
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | query | optional | string | One of: all or none |
GET /members/{idMember}/customEmoji
/members/{idMember}/customEmoji/{idCustomEmoji}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idCustomEmoji | path | required | string | idCustomEmoji |
| fields | query | optional | string | all or a comma-separated list of: name or url |
GET /members/{idMember}/customEmoji/{idCustomEmoji}
/members/{idMember}/customStickers
This gets a list of all of the user’s uploaded stickers
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | query | optional | string | One of: all or none |
GET /members/{idMember}/customStickers
/members/{idMember}/customStickers/{idCustomSticker}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idCustomSticker | path | required | string | idCustomSticker |
| fields | query | optional | string | all or a comma-separated list of: scaled or url |
GET /members/{idMember}/customStickers/{idCustomSticker}
/members/{idMember}/deltas
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| tags | query | required | string | A valid tag for subscribing |
| ixLastUpdate | query | required | string | a number from -1 to Infinity |
GET /members/{idMember}/deltas
/members/{idMember}/notifications
You can only read the notifications for the member associated with the supplied token
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| entities | query | optional | string | true or false |
| display | query | optional | string | true or false |
| filter | query | optional | string | all or a comma-separated list of: addAdminToBoard, addAdminToOrganization, addedAttachmentToCard, addedMemberToCard, addedToBoard, addedToCard, addedToOrganization, cardDueSoon, changeCard, closeBoard, commentCard, createdCard, declinedInvitationToBoard, declinedInvitationToOrganization, invitedToBoard, invitedToOrganization, makeAdminOfBoard, makeAdminOfOrganization, memberJoinedTrello, mentionedOnCard, removedFromBoard, removedFromCard, removedFromOrganization, removedMemberFromCard, unconfirmedInvitedToBoard, unconfirmedInvitedToOrganization or updateCheckItemStateOnCard |
| read_filter | query | optional | string | One of: all, read or unread |
| fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator, type or unread |
| limit | query | optional | string | a number from 1 to 1000 |
| page | query | optional | string | a number from 0 to 100 |
| before | query | optional | string | An id, or null |
| since | query | optional | string | An id, or null |
| memberCreator | query | optional | string | true or false |
| memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /members/{idMember}/notifications
/members/{idMember}/notifications/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | path | required | string | filter |
GET /members/{idMember}/notifications/{filter}
/members/{idMember}/organizations
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | query | optional | string | One of: all, members, none or public |
| fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
| paid_account | query | optional | string | true or false |
GET /members/{idMember}/organizations
/members/{idMember}/organizations/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | path | required | string | filter |
GET /members/{idMember}/organizations/{filter}
/members/{idMember}/organizationsInvited
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
GET /members/{idMember}/organizationsInvited
/members/{idMember}/organizationsInvited/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| field | path | required | string | field |
GET /members/{idMember}/organizationsInvited/{field}
/members/{idMember}/savedSearches
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
GET /members/{idMember}/savedSearches
/members/{idMember}/savedSearches/{idSavedSearch}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idSavedSearch | path | required | string | idSavedSearch |
GET /members/{idMember}/savedSearches/{idSavedSearch}
/members/{idMember}/tokens
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| filter | query | optional | string | One of: all or none |
GET /members/{idMember}/tokens
/members/{idMember}/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| field | path | required | string | field |
GET /members/{idMember}/{field}
/notifications/{idNotification}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| display | query | optional | string | true or false |
| entities | query | optional | string | true or false |
| fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator, type or unread |
| memberCreator | query | optional | string | true or false |
| memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| board | query | optional | string | true or false |
| board_fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| list | query | optional | string | true or false |
| card | query | optional | string | true or false |
| card_fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
| organization | query | optional | string | true or false |
| organization_fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /notifications/{idNotification}
/notifications/{idNotification}/board
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
GET /notifications/{idNotification}/board
/notifications/{idNotification}/board/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| field | path | required | string | field |
GET /notifications/{idNotification}/board/{field}
/notifications/{idNotification}/card
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
GET /notifications/{idNotification}/card
/notifications/{idNotification}/card/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| field | path | required | string | field |
GET /notifications/{idNotification}/card/{field}
/notifications/{idNotification}/display
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
GET /notifications/{idNotification}/display
/notifications/{idNotification}/entities
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
GET /notifications/{idNotification}/entities
/notifications/{idNotification}/list
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| fields | query | optional | string | all or a comma-separated list of: closed, idBoard, name, pos or subscribed |
GET /notifications/{idNotification}/list
/notifications/{idNotification}/list/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| field | path | required | string | field |
GET /notifications/{idNotification}/list/{field}
/notifications/{idNotification}/member
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username |
GET /notifications/{idNotification}/member
/notifications/{idNotification}/member/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| field | path | required | string | field |
GET /notifications/{idNotification}/member/{field}
/notifications/{idNotification}/memberCreator
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username |
GET /notifications/{idNotification}/memberCreator
/notifications/{idNotification}/memberCreator/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| field | path | required | string | field |
GET /notifications/{idNotification}/memberCreator/{field}
/notifications/{idNotification}/organization
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
GET /notifications/{idNotification}/organization
/notifications/{idNotification}/organization/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| field | path | required | string | field |
GET /notifications/{idNotification}/organization/{field}
/notifications/{idNotification}/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
| field | path | required | string | field |
GET /notifications/{idNotification}/{field}
/organizations/{idOrg}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| actions_entities | query | optional | string | true or false |
| actions_display | query | optional | string | true or false |
| actions_limit | query | optional | string | a number from 0 to 1000 |
| action_fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| memberships | query | optional | string | all or a comma-separated list of: active, admin, deactivated, me or normal |
| memberships_member | query | optional | string | true or false |
| memberships_member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| members | query | optional | string | One of: admins, all, none, normal or owners |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| member_activity | query | optional | string | true or false ; works for premium organizations only. |
| membersInvited | query | optional | string | One of: admins, all, none, normal or owners |
| membersInvited_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| boards | query | optional | string | all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned |
| board_fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| board_actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| board_actions_entities | query | optional | string | true or false |
| board_actions_display | query | optional | string | true or false |
| board_actions_format | query | optional | string | One of: count, list or minimal |
| board_actions_since | query | optional | string | A date, null or lastView |
| board_actions_limit | query | optional | string | a number from 0 to 1000 |
| board_action_fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| board_lists | query | optional | string | One of: all, closed, none or open |
| paid_account | query | optional | string | true or false |
| fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
GET /organizations/{idOrg}
/organizations/{idOrg}/actions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| entities | query | optional | string | true or false |
| display | query | optional | string | true or false |
| filter | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| limit | query | optional | string | a number from 0 to 1000 |
| format | query | optional | string | One of: count, list or minimal |
| since | query | optional | string | A date, null or lastView |
| before | query | optional | string | A date, or null |
| page | query | optional | string | Page * limit must be less than 1000 |
| idModels | query | optional | string | Only return actions related to these model ids |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| memberCreator | query | optional | string | true or false |
| memberCreator_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /organizations/{idOrg}/actions
/organizations/{idOrg}/boards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| filter | query | optional | string | all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned |
| fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| actions_entities | query | optional | string | true or false |
| actions_limit | query | optional | string | a number from 0 to 1000 |
| actions_format | query | optional | string | One of: count, list or minimal |
| actions_since | query | optional | string | A date, null or lastView |
| action_fields | query | optional | string | all or a comma-separated list of: data, date, idMemberCreator or type |
| memberships | query | optional | string | all or a comma-separated list of: active, admin, deactivated, me or normal |
| organization | query | optional | string | true or false |
| organization_fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
| lists | query | optional | string | One of: all, closed, none or open |
GET /organizations/{idOrg}/boards
/organizations/{idOrg}/boards/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| filter | path | required | string | filter |
GET /organizations/{idOrg}/boards/{filter}
/organizations/{idOrg}/deltas
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| tags | query | required | string | A valid tag for subscribing |
| ixLastUpdate | query | required | string | a number from -1 to Infinity |
GET /organizations/{idOrg}/deltas
/organizations/{idOrg}/members
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| filter | query | optional | string | One of: admins, all, none, normal or owners |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| activity | query | optional | string | true or false ; works for premium organizations only. |
GET /organizations/{idOrg}/members
/organizations/{idOrg}/members/{filter}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| filter | path | required | string | filter |
GET /organizations/{idOrg}/members/{filter}
/organizations/{idOrg}/members/{idMember}/cards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| idMember | path | required | string | idMember |
| actions | query | optional | string | all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization |
| attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| attachment_fields | query | optional | string | all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url |
| members | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| checkItemStates | query | optional | string | true or false |
| checklists | query | optional | string | One of: all or none |
| board | query | optional | string | true or false |
| board_fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| list | query | optional | string | true or false |
| list_fields | query | optional | string | all or a comma-separated list of: closed, idBoard, name, pos or subscribed |
| filter | query | optional | string | One of: all, closed, none, open or visible |
| fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
GET /organizations/{idOrg}/members/{idMember}/cards
/organizations/{idOrg}/membersInvited
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| fields | query | optional | string | all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username |
GET /organizations/{idOrg}/membersInvited
/organizations/{idOrg}/membersInvited/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| field | path | required | string | field |
GET /organizations/{idOrg}/membersInvited/{field}
/organizations/{idOrg}/memberships
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| filter | query | optional | string | all or a comma-separated list of: active, admin, deactivated, me or normal |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /organizations/{idOrg}/memberships
/organizations/{idOrg}/memberships/{idMembership}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| idMembership | path | required | string | idMembership |
| member | query | optional | string | true or false |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
GET /organizations/{idOrg}/memberships/{idMembership}
/organizations/{idOrg}/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| field | path | required | string | field |
GET /organizations/{idOrg}/{field}
/search
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| query | query | required | string | a string with a length from 1 to 16384 |
| idBoards | query | optional | string | A comma-separated list of objectIds, 24-character hex strings |
| idOrganizations | query | required | string | A comma-separated list of objectIds, 24-character hex strings |
| idCards | query | optional | string | A comma-separated list of objectIds, 24-character hex strings |
| modelTypes | query | optional | string | all or a comma-separated list of: actions, boards, cards, members or organizations |
| board_fields | query | optional | string | all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url |
| boards_limit | query | optional | string | a number from 1 to 1000 |
| card_fields | query | optional | string | all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url |
| cards_limit | query | optional | string | a number from 1 to 1000 |
| cards_page | query | optional | string | a number from 0 to 100 |
| card_board | query | optional | string | true or false |
| card_list | query | optional | string | true or false |
| card_members | query | optional | string | true or false |
| card_stickers | query | optional | string | true or false |
| card_attachments | query | optional | string | A boolean value or "cover" for only card cover attachments |
| organization_fields | query | optional | string | all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website |
| organizations_limit | query | optional | string | a number from 1 to 1000 |
| member_fields | query | optional | string | all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username |
| members_limit | query | optional | string | a number from 1 to 1000 |
| partial | query | optional | string | true or false |
GET /search
/search/members
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| query | query | required | string | a string with a length from 1 to 16384 |
| limit | query | optional | string | a number from 1 to 20 |
| idBoard | query | optional | string | An id, or null |
| idOrganization | query | optional | string | An id, or null |
| onlyOrgMembers | query | optional | string | A boolean |
GET /search/members
/sessions/socket
This is the route for WebSocket requests. See the socket API reference for a description of WebSocket usage.
GET /sessions/socket
/tokens/{token}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | string | all or a comma-separated list of: dateCreated, dateExpires, idMember, identifier or permissions |
| webhooks | query | optional | string | true or false |
GET /tokens/{token}
/tokens/{token}/member
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | string | all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username |
GET /tokens/{token}/member
/tokens/{token}/member/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| field | path | required | string | field |
GET /tokens/{token}/member/{field}
/tokens/{token}/webhooks
GET /tokens/{token}/webhooks
/tokens/{token}/webhooks/{idWebhook}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idWebhook | path | required | string | idWebhook |
GET /tokens/{token}/webhooks/{idWebhook}
/tokens/{token}/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | path | required | string | token |
| field | path | required | string | field |
GET /tokens/{token}/{field}
/types/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | id |
GET /types/{id}
/webhooks/{idWebhook}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idWebhook | path | required | string | idWebhook |
GET /webhooks/{idWebhook}
/webhooks/{idWebhook}/{field}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idWebhook | path | required | string | idWebhook |
| field | path | required | string | field |
GET /webhooks/{idWebhook}/{field}
actions
{
"xml": {
"name": "action"
},
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
actions_comments
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
actions_text
{
"xml": {
"name": "action"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"closed": {
"type": "string",
"description": " true or false"
},
"powerUps": {
"type": "string",
"description": "all or a comma-separated list of: calendar, cardAging, recap or voting"
},
"subscribed": {
"type": "string",
"description": " true or false"
},
"prefs/voting": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"prefs_voting": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"idBoardSource": {
"type": "string",
"description": "The id of the board to copy into the new board"
},
"idOrganization": {
"type": "string",
"description": "The id or name of the organization to add the board to."
},
"keepFromSource": {
"type": "string",
"description": "Components of the source board to copy."
},
"labelNames/red": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/comments": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"prefs/selfJoin": {
"type": "string",
"description": " true or false"
},
"prefs_comments": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"prefs_selfJoin": {
"type": "string",
"description": " true or false"
},
"labelNames/blue": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/cardAging": {
"type": "string",
"description": "One of: pirate or regular"
},
"prefs_cardAging": {
"type": "string",
"description": "One of: pirate or regular"
},
"labelNames/green": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/background": {
"type": "string",
"description": "A standard background name, or the id of a custom background"
},
"prefs/cardCovers": {
"type": "string",
"description": " true or false"
},
"prefs_background": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs_cardCovers": {
"type": "string",
"description": " true or false"
},
"labelNames/orange": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"labelNames/purple": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"labelNames/yellow": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/invitations": {
"type": "string",
"description": "One of: admins or members"
},
"prefs_invitations": {
"type": "string",
"description": "One of: admins or members"
},
"prefs/permissionLevel": {
"type": "string",
"description": "One of: org, private or public"
},
"prefs_permissionLevel": {
"type": "string",
"description": "One of: org, private or public"
},
"prefs/calendarFeedEnabled": {
"type": "string",
"description": " true or false"
}
}
}
boards_checklists
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards_closed
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
boards_desc
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
boards_idOrganization
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
boards_labels
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"color": {
"type": "string",
"description": "A valid label color or null"
}
}
}
boards_lists
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards_members
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"email": {
"type": "string",
"description": "An email address"
},
"fullName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
boards_memberships
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"member_fields": {
"type": "string",
"description": "all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"
}
}
}
boards_name
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards_powerUps
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: calendar, cardAging, recap or voting"
}
}
}
boards_subscribed
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
cards
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"due": {
"type": "string",
"description": "A date, or null"
},
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "The name of the new card. It isn't required if the name is being copied from provided by a URL, file or card that is being copied."
},
"closed": {
"type": "string",
"description": " true or false"
},
"idList": {
"type": "string",
"description": "id of the list that the card should be added to"
},
"labels": {
"type": "string",
"description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
},
"idBoard": {
"type": "string",
"description": "id of the board the card should be moved to"
},
"idLabels": {
"type": "string",
"description": "A comma-separated list of objectIds, 24-character hex strings"
},
"idMembers": {
"type": "string",
"description": "A comma-separated list of objectIds, 24-character hex strings"
},
"urlSource": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
},
"fileSource": {
"type": "string",
"description": "A file"
},
"subscribed": {
"type": "string",
"description": " true or false"
},
"idCardSource": {
"type": "string",
"description": "The id of the card to copy into a new card."
},
"keepFromSource": {
"type": "string",
"description": "Properties of the card to copy over from the source."
},
"idAttachmentCover": {
"type": "string",
"description": "Id of the image attachment of this card to use as its cover, or null for no cover"
}
}
}
cards_actions_comments
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_attachments
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
},
"file": {
"type": "string",
"description": "A file"
},
"name": {
"type": "string",
"description": "a string with a length from 0 to 256"
},
"mimeType": {
"type": "string",
"description": "a string with a length from 0 to 256"
}
}
}
cards_checklist_checkItem
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_checklist_checkItem_name
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_checklist_checkItem_pos
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
cards_checklist_checkItem_state
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: complete, false, incomplete or true"
}
}
}
cards_checklist_idChecklistCurrent_checkItem
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"state": {
"type": "string",
"description": "One of: complete, false, incomplete or true"
},
"idChecklist": {
"type": "string",
"description": "An id, or null"
}
}
}
cards_checklists
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"value": {
"type": "string",
"description": "The id of the checklist to add to the card, or null to create a new one."
},
"idChecklistSource": {
"type": "string",
"description": "The id of the source checklist to copy into a new checklist."
}
}
}
cards_closed
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
cards_desc
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
cards_due
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A date, or null"
}
}
}
cards_idAttachmentCover
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Id of the image attachment of this card to use as its cover, or null for no cover"
}
}
}
cards_idBoard
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "id of the board the card should be moved to"
},
"idList": {
"type": "string",
"description": "id of the list that the card should be moved to on the new board"
}
}
}
cards_idLabels
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the label to add"
}
}
}
cards_idList
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "id of the list the card should be moved to"
}
}
}
cards_idMembers
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the member to add to the card"
}
}
}
cards_labels
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"color": {
"type": "string",
"description": "A valid label color or null"
},
"value": {
"type": "string",
"description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
}
}
}
cards_membersVoted
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the member to vote 'yes' on the card"
}
}
}
cards_name
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_pos
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
cards_stickers
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"top": {
"type": "string",
"description": "undefined"
},
"left": {
"type": "string",
"description": "undefined"
},
"image": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"rotate": {
"type": "string",
"description": "undefined"
},
"zIndex": {
"type": "string",
"description": "Valid Z values for stickers, must be an integer"
}
}
}
cards_subscribed
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
checklists
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"idCard": {
"type": "string",
"description": "id of the card that the checklist should be added to"
},
"idBoard": {
"type": "string",
"description": "id of the board that the checklist should be added to"
},
"idChecklistSource": {
"type": "string",
"description": "The id of the source checklist to copy into a new checklist."
}
}
}
checklists_checkItems
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"checked": {
"type": "string",
"description": " true or false"
}
}
}
checklists_idCard
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the card that the checklist is on"
}
}
}
checklists_name
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
checklists_pos
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
labelNames_blue
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_green
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_orange
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_purple
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_red
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_yellow
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labels
{
"xml": {
"name": "label"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"color": {
"type": "string",
"description": "A valid label color or null"
},
"idBoard": {
"type": "string",
"description": "An id"
}
}
}
labels_color
{
"xml": {
"name": "label"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A valid label color or null"
}
}
}
labels_name
{
"xml": {
"name": "label"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
lists
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"closed": {
"type": "string",
"description": " true or false"
},
"idBoard": {
"type": "string",
"description": "id of the board that the list should be added to"
},
"subscribed": {
"type": "string",
"description": " true or false"
},
"idListSource": {
"type": "string",
"description": "The id of the list to copy into a new list."
}
}
}
lists_cards
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"due": {
"type": "string",
"description": "A date, or null"
},
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"labels": {
"type": "string",
"description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
},
"idMembers": {
"type": "string",
"description": "A comma-separated list of objectIds, 24-character hex strings"
}
}
}
lists_closed
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
lists_idBoard
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "position of the list on the new board"
},
"value": {
"type": "string",
"description": "id of the board the list should be moved to"
}
}
}
lists_moveAllCards
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"idBoard": {
"type": "string",
"description": "id of the board that the cards should be moved to"
}
}
}
lists_name
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
lists_pos
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
lists_subscribed
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
members
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"bio": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"fullName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
},
"initials": {
"type": "string",
"description": "A string with a length from 1 to 4. Cannot begin or end with a space"
},
"username": {
"type": "string",
"description": "A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique."
},
"avatarSource": {
"type": "string",
"description": "One of: gravatar, none or upload"
},
"prefs/locale": {
"type": "string",
"description": "a string with a length from 0 to 255"
},
"prefs/colorBlind": {
"type": "string",
"description": " true or false"
},
"prefs/minutesBetweenSummaries": {
"type": "string",
"description": "-1 (disabled), 1 or 60"
}
}
}
members_avatar
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
}
}
}
members_avatarSource
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: gravatar, none or upload"
}
}
}
members_bio
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
members_boardBackgrounds
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
},
"tile": {
"type": "string",
"description": " true or false"
},
"brightness": {
"type": "string",
"description": "One of: dark, light or unknown"
}
}
}
members_boardStars
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"idBoard": {
"type": "string",
"description": "The id of the board to star"
}
}
}
members_boardStars_idBoard
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "An id"
}
}
}
members_boardStars_pos
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
members_customBoardBackgrounds
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
},
"tile": {
"type": "string",
"description": " true or false"
},
"brightness": {
"type": "string",
"description": "One of: dark, light or unknown"
}
}
}
members_customEmoji
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
},
"name": {
"type": "string",
"description": "a string with a length from 2 to 64"
}
}
}
members_customStickers
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
}
}
}
members_fullName
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
members_initials
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length from 1 to 4. Cannot begin or end with a space"
}
}
}
members_oneTimeMessagesDismissed
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Type of message dismissed"
}
}
}
members_savedSearches
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "A non-empty string with at least one non-space character"
},
"query": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
members_savedSearches_name
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A non-empty string with at least one non-space character"
}
}
}
members_savedSearches_pos
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
members_savedSearches_query
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
members_username
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique."
}
}
}
myPrefs_emailPosition
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: bottom or top"
}
}
}
myPrefs_idEmailList
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "An id"
}
}
}
myPrefs_showListGuide
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebar
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebarActivity
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebarBoardActions
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebarMembers
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
notifications
{
"xml": {
"name": "notification"
},
"type": "object",
"properties": {
"unread": {
"type": "string",
"description": " true or false"
}
}
}
notifications_unread
{
"xml": {
"name": "notification"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
organizations
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"website": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
},
"displayName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
},
"prefs/permissionLevel": {
"type": "string",
"description": "One of: private or public"
},
"prefs/associatedDomain": {
"type": "string",
"description": "The google apps domain to link this org to."
},
"prefs/googleAppsVersion": {
"type": "string",
"description": "a number from 1 to 2"
},
"prefs/orgInviteRestrict": {
"type": "string",
"description": "An email address with optional expansion tokens"
},
"prefs/externalMembersDisabled": {
"type": "string",
"description": " true or false"
},
"prefs/boardVisibilityRestrict/org": {
"type": "string",
"description": "One of: admin, none or org"
},
"prefs/boardVisibilityRestrict/public": {
"type": "string",
"description": "One of: admin, none or org"
},
"prefs/boardVisibilityRestrict/private": {
"type": "string",
"description": "One of: admin, none or org"
}
}
}
organizations_desc
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
organizations_displayName
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
organizations_logo
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
}
}
}
organizations_members
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"email": {
"type": "string",
"description": "An email address"
},
"fullName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
organizations_members_deactivated
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
organizations_memberships
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"member_fields": {
"type": "string",
"description": "all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"
}
}
}
organizations_name
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique."
}
}
}
organizations_website
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
}
}
}
prefs_associatedDomain
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The google apps domain to link this org to."
}
}
}
prefs_background
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A standard background name, or the id of a custom background"
}
}
}
prefs_boardVisibilityRestrict
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: admin, none or org"
}
}
}
prefs_calendarFeedEnabled
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_cardAging
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: pirate or regular"
}
}
}
prefs_cardCovers
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_colorBlind
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_comments
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
}
}
}
prefs_externalMembersDisabled
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_googleAppsVersion
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a number from 1 to 2"
}
}
}
prefs_invitations
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: admins or members"
}
}
}
prefs_locale
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 255"
}
}
}
prefs_minutesBetweenSummaries
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "-1 (disabled), 1 or 60"
}
}
}
prefs_orgInviteRestrict
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "An email address with optional expansion tokens"
}
}
}
prefs_permissionLevel
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: private or public"
}
}
}
prefs_selfJoin
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_voting
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
}
}
}
sessions
{
"xml": {
"name": "session"
},
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "One of: active, disconnected or idle"
},
"idBoard": {
"type": "string",
"description": "The id of the board you're viewing. Boards with no viewers will not get updates about members' statuses."
}
}
}
sessions_status
{
"xml": {
"name": "session"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: active, disconnected or idle"
}
}
}
tokens_webhooks
{
"xml": {
"name": "token"
},
"type": "object",
"properties": {
"idModel": {
"type": "string",
"description": "id of the model to be monitored"
},
"callbackURL": {
"type": "string",
"description": "A valid URL that is reachable with a HEAD request"
},
"description": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
webhooks
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"active": {
"type": "string",
"description": " true or false"
},
"idModel": {
"type": "string",
"description": "id of the model that should be hooked"
},
"callbackURL": {
"type": "string",
"description": "A valid URL that is reachable with a HEAD request"
},
"description": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
webhooks_active
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
webhooks_callbackURL
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A valid URL that is reachable with a HEAD request"
}
}
}
webhooks_description
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
webhooks_idModel
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "id of the model to be monitored"
}
}
}