openapi.city
Sign in

Trello

Visual project management and collaboration

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

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

Get API Key

Server URLs

https://trello.com/1

Endpoints

Clear filters
GET POST PUT PATCH DELETE

Action 16 endpoints

GET /actions/{idAction}
operationId: Action_getById

Parameters

Name In Required Type Description
idAction path required string

idAction
display query optional string

true or false
entities query optional string

true or false
fields query optional string

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

true or false
member_fields query optional string

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

true or false
memberCreator_fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idAction path required string

idAction
field path required string

field

Responses

200

Success
400

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

Batch 1 endpoints

GET /batch
operationId: Batch_getData

Parameters

Name In Required Type Description
urls query required string

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

Responses

200

Success
400

Server rejection
GET /batch

Board 23 endpoints

GET /boards/{idBoard}
operationId: Board_getById

Parameters

Name In Required Type Description
idBoard path required string

board_id
actions query optional string

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

true or false
actions_display query optional string

true or false
actions_format query optional string

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

A date, null or lastView
actions_limit query optional string

a number from 0 to 1000
action_fields query optional string

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

true or false
action_member_fields query optional string

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

true or false
action_memberCreator_fields query optional string

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

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url
card_attachments query optional string

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

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

One of: all or none
card_stickers query optional string

true or false
boardStars query optional string

One of: mine or none
labels query optional string

One of: all or none
label_fields query optional string

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

a number from 0 to 1000
lists query optional string

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

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

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

true or false
memberships_member_fields query optional string

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

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

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

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

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

One of: all or none
checklist_fields query optional string

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

true or false
organization_fields query optional string

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

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

true or false
fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
entities query optional string

true or false
display query optional string

true or false
filter query optional string

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

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

a number from 0 to 1000
format query optional string

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

A date, null or lastView
before query optional string

A date, or null
page query optional string

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

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

true or false
member_fields query optional string

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

true or false
memberCreator_fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
filter query optional string

One of: mine or none

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/boardStars
GET /boards/{idBoard}/cards
operationId: Board_getCardsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
actions query optional string

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

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

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

true or false
members query optional string

true or false
member_fields query optional string

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

true or false
checklists query optional string

One of: all or none
limit query optional string

a number from 1 to 1000
since query optional string

A date, or null
before query optional string

A date, or null
filter query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
filter path required string

filter

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
idCard path required string

idCard
attachments query optional string

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

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

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

true or false
actions_display query optional string

true or false
actions_limit query optional string

a number from 0 to 1000
action_fields query optional string

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

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

true or false
member_fields query optional string

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

true or false
checkItemState_fields query optional string

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

true or false
checklists query optional string

One of: all or none
checklist_fields query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
cards query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url
checkItems query optional string

One of: all or none
checkItem_fields query optional string

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

One of: all or none
fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
tags query required string

A valid tag for subscribing
ixLastUpdate query required string

a number from -1 to Infinity

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/deltas
GET /boards/{idBoard}/labels
operationId: Board_listLabelsByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
fields query optional string

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

a number from 0 to 1000

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
idLabel path required string

idLabel
fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
cards query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url
filter query optional string

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

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
filter path required string

filter

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/lists/{filter}
GET /boards/{idBoard}/members
operationId: Board_getMembersByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
filter query optional string

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

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

true or false ; works for premium organizations only.

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/members
GET /boards/{idBoard}/members/{filter}
operationId: Board_getMembersByFilter

Parameters

Name In Required Type Description
idBoard path required string

board_id
filter path required string

filter

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/members/{filter}
GET /boards/{idBoard}/members/{idMember}/cards
operationId: Board_getMembersCardsByIdBoardByIdMember

Parameters

Name In Required Type Description
idBoard path required string

board_id
idMember path required string

idMember
actions query optional string

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

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

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

true or false
member_fields query optional string

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

true or false
checklists query optional string

One of: all or none
board query optional string

true or false
board_fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url
list query optional string

true or false
list_fields query optional string

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

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/members/{idMember}/cards
GET /boards/{idBoard}/membersInvited
operationId: Board_getMembersInvitedByIdBoard

Parameters

Name In Required Type Description
idBoard path required string

board_id
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/membersInvited
GET /boards/{idBoard}/membersInvited/{field}
operationId: Board_getMembersInvitedByField

Parameters

Name In Required Type Description
idBoard path required string

board_id
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
filter query optional string

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

true or false
member_fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idBoard path required string

board_id
idMembership path required string

idMembership
member query optional string

true or false
member_fields query optional string

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

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/memberships/{idMembership}
GET /boards/{idBoard}/myPrefs
operationId: Board_getMyPrefsById

Parameters

Name In Required Type Description
idBoard path required string

board_id

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/myPrefs
GET /boards/{idBoard}/organization
operationId: Board_getOrganizationById

Parameters

Name In Required Type Description
idBoard path required string

board_id
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/organization
GET /boards/{idBoard}/organization/{field}
operationId: Board_getOrganizationByIdBoardByField

Parameters

Name In Required Type Description
idBoard path required string

board_id
field path required string

field

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/organization/{field}
GET /boards/{idBoard}/{field}
operationId: Board_getByIdField

Parameters

Name In Required Type Description
idBoard path required string

board_id
field path required string

field

Responses

200

Success
400

Server rejection
GET /boards/{idBoard}/{field}

Card 15 endpoints

GET /cards/{idCard}
operationId: Card_getById

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
actions query optional string

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

true or false
actions_display query optional string

true or false
actions_limit query optional string

a number from 0 to 1000
action_fields query optional string

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

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

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

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

true or false
member_fields query optional string

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

true or false
memberVoted_fields query optional string

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

true or false
checkItemState_fields query optional string

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

One of: all or none
checklist_fields query optional string

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

true or false
board_fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url
list query optional string

true or false
list_fields query optional string

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

true or false
sticker_fields query optional string

all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex
fields query optional string

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url

Responses

200

Success
400

Server rejection
GET /cards/{idCard}
GET /cards/{idCard}/actions
operationId: Card_listCardActionsById

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
entities query optional string

true or false
display query optional string

true or false
filter query optional string

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

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

a number from 0 to 1000
format query optional string

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

A date, null or lastView
before query optional string

A date, or null
page query optional string

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

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

true or false
member_fields query optional string

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

true or false
memberCreator_fields query optional string

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

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/actions
GET /cards/{idCard}/attachments
operationId: Card_getAttachmentsByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
fields query optional string

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

A boolean value or "cover" for only card cover attachments

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/attachments
GET /cards/{idCard}/attachments/{idAttachment}
operationId: Card_getAttachmentsByIds

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
idAttachment path required string

idAttachment
fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/board
GET /cards/{idCard}/board/{field}
operationId: Card_getBoardByIdCardByField

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
fields query optional string

all or a comma-separated list of: idCheckItem or state

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/checkItemStates
GET /cards/{idCard}/checklists
operationId: Card_getChecklistsById

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
cards query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url
checkItems query optional string

One of: all or none
checkItem_fields query optional string

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

One of: all or none
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/checklists
GET /cards/{idCard}/list
operationId: Card_getListById

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
field path required string

field

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/list/{field}
GET /cards/{idCard}/members
operationId: Card_listMembersByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/members
GET /cards/{idCard}/membersVoted
operationId: Card_getMembersVotedByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/membersVoted
GET /cards/{idCard}/stickers
operationId: Card_getStickersByIdCard

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
fields query optional string

all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/stickers
GET /cards/{idCard}/stickers/{idSticker}
operationId: Card_getStickerByIds

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
idSticker path required string

idSticker
fields query optional string

all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/stickers/{idSticker}
GET /cards/{idCard}/{field}
operationId: Card_getByIdField

Parameters

Name In Required Type Description
idCard path required string

card id or shortlink
field path required string

field

Responses

200

Success
400

Server rejection
GET /cards/{idCard}/{field}

Checklist 8 endpoints

GET /checklists/{idChecklist}
operationId: Checklist_getById

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist
cards query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url
checkItems query optional string

One of: all or none
checkItem_fields query optional string

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

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

Responses

200

Success
400

Server rejection
GET /checklists/{idChecklist}
GET /checklists/{idChecklist}/board
operationId: Checklist_getBoardByIdChecklist

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist
fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url

Responses

200

Success
400

Server rejection
GET /checklists/{idChecklist}/board
GET /checklists/{idChecklist}/board/{field}
operationId: Checklist_getBoardByIdChecklistByField

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist
actions query optional string

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

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

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

true or false
members query optional string

true or false
member_fields query optional string

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

true or false
checklists query optional string

One of: all or none
limit query optional string

a number from 1 to 1000
since query optional string

A date, or null
before query optional string

A date, or null
filter query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url

Responses

200

Success
400

Server rejection
GET /checklists/{idChecklist}/cards
GET /checklists/{idChecklist}/cards/{filter}
operationId: Checklist_getCardsByFilter

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist
filter path required string

filter

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist
filter query optional string

One of: all or none
fields query optional string

all or a comma-separated list of: name, nameData, pos, state or type

Responses

200

Success
400

Server rejection
GET /checklists/{idChecklist}/checkItems
GET /checklists/{idChecklist}/checkItems/{idCheckItem}
operationId: Checklist_getCheckItemsByIdChecklistByIdCheckItem

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist
idCheckItem path required string

idCheckItem
fields query optional string

all or a comma-separated list of: name, nameData, pos, state or type

Responses

200

Success
400

Server rejection
GET /checklists/{idChecklist}/checkItems/{idCheckItem}
GET /checklists/{idChecklist}/{field}
operationId: Checklist_getByIdField

Parameters

Name In Required Type Description
idChecklist path required string

idChecklist
field path required string

field

Responses

200

Success
400

Server rejection
GET /checklists/{idChecklist}/{field}

Label 3 endpoints

GET /labels/{idLabel}
operationId: Label_getByIdLabel

Parameters

Name In Required Type Description
idLabel path required string

idLabel
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /labels/{idLabel}
GET /labels/{idLabel}/board
operationId: Label_getBoardByIdLabel

Parameters

Name In Required Type Description
idLabel path required string

idLabel
fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url

Responses

200

Success
400

Server rejection
GET /labels/{idLabel}/board
GET /labels/{idLabel}/board/{field}
operationId: Label_getBoardByIdLabelByField

Parameters

Name In Required Type Description
idLabel path required string

idLabel
field path required string

field

Responses

200

Success
400

Server rejection
GET /labels/{idLabel}/board/{field}

List 7 endpoints

GET /lists/{idList}
operationId: List_getByIdList

Parameters

Name In Required Type Description
idList path required string

idList
cards query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url
board query optional string

true or false
board_fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /lists/{idList}
GET /lists/{idList}/actions
operationId: List_getActionsByIdList

Parameters

Name In Required Type Description
idList path required string

idList
entities query optional string

true or false
display query optional string

true or false
filter query optional string

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

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

a number from 0 to 1000
format query optional string

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

A date, null or lastView
before query optional string

A date, or null
page query optional string

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

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

true or false
member_fields query optional string

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

true or false
memberCreator_fields query optional string

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

Responses

200

Success
400

Server rejection
GET /lists/{idList}/actions
GET /lists/{idList}/board
operationId: List_idBoardGet

Parameters

Name In Required Type Description
idList path required string

idList
fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url

Responses

200

Success
400

Server rejection
GET /lists/{idList}/board
GET /lists/{idList}/board/{field}
operationId: List_getBoardByIdListByField

Parameters

Name In Required Type Description
idList path required string

idList
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idList path required string

idList
actions query optional string

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

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

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

true or false
members query optional string

true or false
member_fields query optional string

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

true or false
checklists query optional string

One of: all or none
limit query optional string

a number from 1 to 1000
since query optional string

A date, or null
before query optional string

A date, or null
filter query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url

Responses

200

Success
400

Server rejection
GET /lists/{idList}/cards
GET /lists/{idList}/cards/{filter}
operationId: List_getCardsByFilter

Parameters

Name In Required Type Description
idList path required string

idList
filter path required string

filter

Responses

200

Success
400

Server rejection
GET /lists/{idList}/cards/{filter}
GET /lists/{idList}/{field}
operationId: List_getByIdListByField

Parameters

Name In Required Type Description
idList path required string

idList
field path required string

field

Responses

200

Success
400

Server rejection
GET /lists/{idList}/{field}

Member 29 endpoints

GET /members/{idMember}

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

operationId: Member_getById

Parameters

Name In Required Type Description
idMember path required string

idMember or username
actions query optional string

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

true or false
actions_display query optional string

true or false
actions_limit query optional string

a number from 0 to 1000
action_fields query optional string

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

A date, null or lastView
action_before query optional string

A date, or null
cards query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url
card_members query optional string

true or false
card_member_fields query optional string

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

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

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

true or false
boards query optional string

all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned
board_fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url
board_actions query optional string

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

true or false
board_actions_display query optional string

true or false
board_actions_format query optional string

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

A date, null or lastView
board_actions_limit query optional string

a number from 0 to 1000
board_action_fields query optional string

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

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

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

true or false
board_organization_fields query optional string

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

all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned
boardsInvited_fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url
boardStars query optional string

true or false
savedSearches query optional string

true or false
organizations query optional string

One of: all, members, none or public
organization_fields query optional string

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

true or false
organizationsInvited query optional string

One of: all, members, none or public
organizationsInvited_fields query optional string

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

all or a comma-separated list of: addAdminToBoard, addAdminToOrganization, addedAttachmentToCard, addedMemberToCard, addedToBoard, addedToCard, addedToOrganization, cardDueSoon, changeCard, closeBoard, commentCard, createdCard, declinedInvitationToBoard, declinedInvitationToOrganization, invitedToBoard, invitedToOrganization, makeAdminOfBoard, makeAdminOfOrganization, memberJoinedTrello, mentionedOnCard, removedFromBoard, removedFromCard, removedFromOrganization, removedMemberFromCard, unconfirmedInvitedToBoard, unconfirmedInvitedToOrganization or updateCheckItemStateOnCard
notifications_entities query optional string

true or false
notifications_display query optional string

true or false
notifications_limit query optional string

a number from 1 to 1000
notification_fields query optional string

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

true or false
notification_memberCreator_fields query optional string

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

An id, or null
notification_since query optional string

An id, or null
tokens query optional string

One of: all or none
paid_account query optional string

true or false
boardBackgrounds query optional string

One of: all, custom, default, none or premium
customBoardBackgrounds query optional string

One of: all or none
customStickers query optional string

One of: all or none
customEmoji query optional string

One of: all or none
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /members/{idMember}
GET /members/{idMember}/actions
operationId: Member_listActionsByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username
entities query optional string

true or false
display query optional string

true or false
filter query optional string

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

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

a number from 0 to 1000
format query optional string

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

A date, null or lastView
before query optional string

A date, or null
page query optional string

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

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

true or false
member_fields query optional string

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

true or false
memberCreator_fields query optional string

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

Responses

200

Success
400

Server rejection
GET /members/{idMember}/actions
GET /members/{idMember}/boardBackgrounds
operationId: Member_getBoardBackgroundsById

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter query optional string

One of: all, custom, default, none or premium

Responses

200

Success
400

Server rejection
GET /members/{idMember}/boardBackgrounds
GET /members/{idMember}/boardBackgrounds/{idBoardBackground}
operationId: Member_getBoardBackgroundByIds

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idBoardBackground path required string

idBoardBackground
fields query optional string

all or a comma-separated list of: brightness, fullSizeUrl, scaled or tile

Responses

200

Success
400

Server rejection
GET /members/{idMember}/boardBackgrounds/{idBoardBackground}
GET /members/{idMember}/boardStars
operationId: Member_getBoardStarsById

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Responses

200

Success
400

Server rejection
GET /members/{idMember}/boardStars
GET /members/{idMember}/boardStars/{idBoardStar}
operationId: Member_getBoardStarByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idBoardStar path required string

idBoardStar

Responses

200

Success
400

Server rejection
GET /members/{idMember}/boardStars/{idBoardStar}
GET /members/{idMember}/boards
operationId: Member_getBoardsByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter query optional string

all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned
fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url
actions query optional string

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

true or false
actions_limit query optional string

a number from 0 to 1000
actions_format query optional string

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

A date, null or lastView
action_fields query optional string

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

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

true or false
organization_fields query optional string

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

One of: all, closed, none or open

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter path required string

filter

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idMember path required string

idMember or username
fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url

Responses

200

Success
400

Server rejection
GET /members/{idMember}/boardsInvited
GET /members/{idMember}/boardsInvited/{field}
operationId: Member_getBoardsInvitedByIdMemberByField

Parameters

Name In Required Type Description
idMember path required string

idMember or username
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idMember path required string

idMember or username
actions query optional string

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

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

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

true or false
members query optional string

true or false
member_fields query optional string

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

true or false
checklists query optional string

One of: all or none
limit query optional string

a number from 1 to 1000
since query optional string

A date, or null
before query optional string

A date, or null
filter query optional string

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url

Responses

200

Success
400

Server rejection
GET /members/{idMember}/cards
GET /members/{idMember}/cards/{filter}
operationId: Member_getCardsByFilter

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter path required string

filter

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter query optional string

One of: all or none

Responses

200

Success
400

Server rejection
GET /members/{idMember}/customBoardBackgrounds
GET /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
operationId: Member_getCustomBoardBackgroundByIds

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idBoardBackground path required string

idBoardBackground
fields query optional string

all or a comma-separated list of: brightness, fullSizeUrl, scaled or tile

Responses

200

Success
400

Server rejection
GET /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
GET /members/{idMember}/customEmoji

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

operationId: Member_listCustomEmojiByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter query optional string

One of: all or none

Responses

200

Success
400

Server rejection
GET /members/{idMember}/customEmoji
GET /members/{idMember}/customEmoji/{idCustomEmoji}
operationId: Member_getCustomEmojiByIds

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idCustomEmoji path required string

idCustomEmoji
fields query optional string

all or a comma-separated list of: name or url

Responses

200

Success
400

Server rejection
GET /members/{idMember}/customEmoji/{idCustomEmoji}
GET /members/{idMember}/customStickers

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

operationId: Member_getCustomStickersByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter query optional string

One of: all or none

Responses

200

Success
400

Server rejection
GET /members/{idMember}/customStickers
GET /members/{idMember}/customStickers/{idCustomSticker}
operationId: Member_getCustomStickerByIds

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idCustomSticker path required string

idCustomSticker
fields query optional string

all or a comma-separated list of: scaled or url

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idMember path required string

idMember or username
tags query required string

A valid tag for subscribing
ixLastUpdate query required string

a number from -1 to Infinity

Responses

200

Success
400

Server rejection
GET /members/{idMember}/deltas
GET /members/{idMember}/notifications

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

operationId: Member_getNotificationsByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username
entities query optional string

true or false
display query optional string

true or false
filter query optional string

all or a comma-separated list of: addAdminToBoard, addAdminToOrganization, addedAttachmentToCard, addedMemberToCard, addedToBoard, addedToCard, addedToOrganization, cardDueSoon, changeCard, closeBoard, commentCard, createdCard, declinedInvitationToBoard, declinedInvitationToOrganization, invitedToBoard, invitedToOrganization, makeAdminOfBoard, makeAdminOfOrganization, memberJoinedTrello, mentionedOnCard, removedFromBoard, removedFromCard, removedFromOrganization, removedMemberFromCard, unconfirmedInvitedToBoard, unconfirmedInvitedToOrganization or updateCheckItemStateOnCard
read_filter query optional string

One of: all, read or unread
fields query optional string

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

a number from 1 to 1000
page query optional string

a number from 0 to 100
before query optional string

An id, or null
since query optional string

An id, or null
memberCreator query optional string

true or false
memberCreator_fields query optional string

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

Responses

200

Success
400

Server rejection
GET /members/{idMember}/notifications
GET /members/{idMember}/notifications/{filter}
operationId: Member_getNotificationsByIdMemberByFilter

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter path required string

filter

Responses

200

Success
400

Server rejection
GET /members/{idMember}/notifications/{filter}
GET /members/{idMember}/organizations
operationId: Member_listOrganizationsById

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter query optional string

One of: all, members, none or public
fields query optional string

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

true or false

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter path required string

filter

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idMember path required string

idMember or username
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /members/{idMember}/organizationsInvited
GET /members/{idMember}/organizationsInvited/{field}
operationId: Member_listOrganizationsInvitedByIdMemberByField

Parameters

Name In Required Type Description
idMember path required string

idMember or username
field path required string

field

Responses

200

Success
400

Server rejection
GET /members/{idMember}/organizationsInvited/{field}
GET /members/{idMember}/savedSearches
operationId: Member_getSavedSearchesByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username

Responses

200

Success
400

Server rejection
GET /members/{idMember}/savedSearches
GET /members/{idMember}/savedSearches/{idSavedSearch}
operationId: Member_getSavedSearchByIds

Parameters

Name In Required Type Description
idMember path required string

idMember or username
idSavedSearch path required string

idSavedSearch

Responses

200

Success
400

Server rejection
GET /members/{idMember}/savedSearches/{idSavedSearch}
GET /members/{idMember}/tokens
operationId: Member_getTokensByIdMember

Parameters

Name In Required Type Description
idMember path required string

idMember or username
filter query optional string

One of: all or none

Responses

200

Success
400

Server rejection
GET /members/{idMember}/tokens
GET /members/{idMember}/{field}
operationId: Member_getByField

Parameters

Name In Required Type Description
idMember path required string

idMember or username
field path required string

field

Responses

200

Success
400

Server rejection
GET /members/{idMember}/{field}

Notification 16 endpoints

GET /notifications/{idNotification}
operationId: Notification_getById

Parameters

Name In Required Type Description
idNotification path required string

idNotification
display query optional string

true or false
entities query optional string

true or false
fields query optional string

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

true or false
memberCreator_fields query optional string

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

true or false
board_fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url
list query optional string

true or false
card query optional string

true or false
card_fields query optional string

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url
organization query optional string

true or false
organization_fields query optional string

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

true or false
member_fields query optional string

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

Responses

200

Success
400

Server rejection
GET /notifications/{idNotification}
GET /notifications/{idNotification}/board
operationId: Notification_getBoardById

Parameters

Name In Required Type Description
idNotification path required string

idNotification
fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url

Responses

200

Success
400

Server rejection
GET /notifications/{idNotification}/board
GET /notifications/{idNotification}/board/{field}
operationId: Notification_getBoardByField

Parameters

Name In Required Type Description
idNotification path required string

idNotification
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idNotification path required string

idNotification
fields query optional string

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url

Responses

200

Success
400

Server rejection
GET /notifications/{idNotification}/card
GET /notifications/{idNotification}/card/{field}
operationId: Notification_getCardByIdNotificationByField

Parameters

Name In Required Type Description
idNotification path required string

idNotification
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idNotification path required string

idNotification

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idNotification path required string

idNotification

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idNotification path required string

idNotification
fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idNotification path required string

idNotification
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idNotification path required string

idNotification
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /notifications/{idNotification}/member
GET /notifications/{idNotification}/member/{field}
operationId: Notification_getMemberByIdField

Parameters

Name In Required Type Description
idNotification path required string

idNotification
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idNotification path required string

idNotification
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /notifications/{idNotification}/memberCreator
GET /notifications/{idNotification}/memberCreator/{field}
operationId: Notification_getMemberByIdNotificationByField

Parameters

Name In Required Type Description
idNotification path required string

idNotification
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idNotification path required string

idNotification
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /notifications/{idNotification}/organization
GET /notifications/{idNotification}/organization/{field}
operationId: Notification_getOrganizationByIdNotificationByField

Parameters

Name In Required Type Description
idNotification path required string

idNotification
field path required string

field

Responses

200

Success
400

Server rejection
GET /notifications/{idNotification}/organization/{field}
GET /notifications/{idNotification}/{field}
operationId: Notification_getByIdField

Parameters

Name In Required Type Description
idNotification path required string

idNotification
field path required string

field

Responses

200

Success
400

Server rejection
GET /notifications/{idNotification}/{field}

Organization 13 endpoints

GET /organizations/{idOrg}
operationId: Organization_getByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
actions query optional string

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

true or false
actions_display query optional string

true or false
actions_limit query optional string

a number from 0 to 1000
action_fields query optional string

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

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

true or false
memberships_member_fields query optional string

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

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

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

true or false ; works for premium organizations only.
membersInvited query optional string

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

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

all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned
board_fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url
board_actions query optional string

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

true or false
board_actions_display query optional string

true or false
board_actions_format query optional string

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

A date, null or lastView
board_actions_limit query optional string

a number from 0 to 1000
board_action_fields query optional string

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

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

true or false
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /organizations/{idOrg}
GET /organizations/{idOrg}/actions
operationId: Organization_getActionsByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
entities query optional string

true or false
display query optional string

true or false
filter query optional string

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

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

a number from 0 to 1000
format query optional string

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

A date, null or lastView
before query optional string

A date, or null
page query optional string

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

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

true or false
member_fields query optional string

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

true or false
memberCreator_fields query optional string

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

Responses

200

Success
400

Server rejection
GET /organizations/{idOrg}/actions
GET /organizations/{idOrg}/boards
operationId: Organization_getBoardsByOrgId

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
filter query optional string

all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned
fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url
actions query optional string

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

true or false
actions_limit query optional string

a number from 0 to 1000
actions_format query optional string

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

A date, null or lastView
action_fields query optional string

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

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

true or false
organization_fields query optional string

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

One of: all, closed, none or open

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
filter path required string

filter

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
tags query required string

A valid tag for subscribing
ixLastUpdate query required string

a number from -1 to Infinity

Responses

200

Success
400

Server rejection
GET /organizations/{idOrg}/deltas
GET /organizations/{idOrg}/members
operationId: Organization_getMembersByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
filter query optional string

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

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

true or false ; works for premium organizations only.

Responses

200

Success
400

Server rejection
GET /organizations/{idOrg}/members
GET /organizations/{idOrg}/members/{filter}
operationId: Organization_listMembersByIdOrgByFilter

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
filter path required string

filter

Responses

200

Success
400

Server rejection
GET /organizations/{idOrg}/members/{filter}
GET /organizations/{idOrg}/members/{idMember}/cards
operationId: Organization_listMembersCardsByIdOrgByIdMember

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
idMember path required string

idMember
actions query optional string

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

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

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

true or false
member_fields query optional string

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

true or false
checklists query optional string

One of: all or none
board query optional string

true or false
board_fields query optional string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url
list query optional string

true or false
list_fields query optional string

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

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

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url

Responses

200

Success
400

Server rejection
GET /organizations/{idOrg}/members/{idMember}/cards
GET /organizations/{idOrg}/membersInvited
operationId: Organization_getMembersInvitedByIdOrg

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /organizations/{idOrg}/membersInvited
GET /organizations/{idOrg}/membersInvited/{field}
operationId: Organization_getMembersInvitedByIdOrgByField

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
field path required string

field

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
filter query optional string

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

true or false
member_fields query optional string

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

Responses

200

Success
400

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

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
idMembership path required string

idMembership
member query optional string

true or false
member_fields query optional string

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

Responses

200

Success
400

Server rejection
GET /organizations/{idOrg}/memberships/{idMembership}
GET /organizations/{idOrg}/{field}
operationId: Organization_getByIdAndField

Parameters

Name In Required Type Description
idOrg path required string

idOrg or name
field path required string

field

Responses

200

Success
400

Server rejection
GET /organizations/{idOrg}/{field}

Session 1 endpoints

GET /sessions/socket

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

operationId: Session_getSocketSessions

Responses

200

Success
400

Server rejection
GET /sessions/socket

Token 6 endpoints

GET /tokens/{token}
operationId: Token_getByToken

Parameters

Name In Required Type Description
fields query optional string

all or a comma-separated list of: dateCreated, dateExpires, idMember, identifier or permissions
webhooks query optional string

true or false

Responses

200

Success
400

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

Parameters

Name In Required Type Description
fields query optional string

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

Responses

200

Success
400

Server rejection
GET /tokens/{token}/member
GET /tokens/{token}/member/{field}
operationId: Token_getMemberByField

Parameters

Name In Required Type Description
field path required string

field

Responses

200

Success
400

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

Responses

200

Success
400

Server rejection
GET /tokens/{token}/webhooks
GET /tokens/{token}/webhooks/{idWebhook}
operationId: Token_getWebhookById

Parameters

Name In Required Type Description
idWebhook path required string

idWebhook

Responses

200

Success
400

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

Parameters

Name In Required Type Description
token path required string

token
field path required string

field

Responses

200

Success
400

Server rejection
GET /tokens/{token}/{field}

Type 1 endpoints

GET /types/{id}
operationId: Type_getById

Parameters

Name In Required Type Description
id path required string

id

Responses

200

Success
400

Server rejection
GET /types/{id}

Webhook 2 endpoints

GET /webhooks/{idWebhook}
operationId: Webhook_getById

Parameters

Name In Required Type Description
idWebhook path required string

idWebhook

Responses

200

Success
400

Server rejection
GET /webhooks/{idWebhook}
GET /webhooks/{idWebhook}/{field}
operationId: Webhook_getByIdField

Parameters

Name In Required Type Description
idWebhook path required string

idWebhook
field path required string

field

Responses

200

Success
400

Server rejection
GET /webhooks/{idWebhook}/{field}
Load more endpoints

Schemas

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

Versions

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