Visual project management and collaboration
developer.atlassian.com/cloud/trello/rest ↗Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://trello.com/1
/boards
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards"
}
}
},
"required": true,
"description": "Attributes of \"Boards\" to be added."
}
POST /boards
/boards/{idBoard}/calendarKey/generate
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
POST /boards/{idBoard}/calendarKey/generate
/boards/{idBoard}/checklists
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards_checklists"
}
}
},
"required": true,
"description": "Attributes of \"Boards Checklists\" to be added."
}
POST /boards/{idBoard}/checklists
/boards/{idBoard}/emailKey/generate
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
POST /boards/{idBoard}/emailKey/generate
/boards/{idBoard}/labels
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards_labels"
}
}
},
"required": true,
"description": "Attributes of \"Boards Labels\" to be added."
}
POST /boards/{idBoard}/labels
/boards/{idBoard}/lists
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards_lists"
}
}
},
"required": true,
"description": "Attributes of \"Boards Lists\" to be added."
}
POST /boards/{idBoard}/lists
/boards/{idBoard}/markAsViewed
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
POST /boards/{idBoard}/markAsViewed
/boards/{idBoard}/powerUps
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards_powerUps"
}
}
},
"required": true,
"description": "Attributes of \"Boards Power Ups\" to be added."
}
POST /boards/{idBoard}/powerUps
/cards
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards"
}
}
},
"required": true,
"description": "Attributes of \"Cards\" to be added."
}
POST /cards
/cards/{idCard}/actions/comments
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/actions_comments"
}
}
},
"required": true,
"description": "Attributes of \"Actions Comments\" to be added."
}
POST /cards/{idCard}/actions/comments
/cards/{idCard}/attachments
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_attachments"
}
}
},
"required": true,
"description": "Attributes of \"Cards Attachments\" to be added."
}
POST /cards/{idCard}/attachments
/cards/{idCard}/checklist/{idChecklist}/checkItem
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| idChecklist | path | required | string | idChecklist |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_checklist_checkItem"
}
}
},
"required": true,
"description": "Attributes of \"Cards Checklist Check Item\" to be added."
}
POST /cards/{idCard}/checklist/{idChecklist}/checkItem
/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/convertToCard
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| idChecklist | path | required | string | idChecklist |
| idCheckItem | path | required | string | idCheckItem |
POST /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/convertToCard
/cards/{idCard}/checklists
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_checklists"
}
}
},
"required": true,
"description": "Attributes of \"Cards Checklists\" to be added."
}
POST /cards/{idCard}/checklists
/cards/{idCard}/idLabels
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_idLabels"
}
}
},
"required": true,
"description": "Attributes of \"Cards Id Labels\" to be added."
}
POST /cards/{idCard}/idLabels
/cards/{idCard}/idMembers
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_idMembers"
}
}
},
"required": true,
"description": "Attributes of \"Cards Id Members\" to be added."
}
POST /cards/{idCard}/idMembers
/cards/{idCard}/labels
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_labels"
}
}
},
"required": true,
"description": "Attributes of \"Cards Labels\" to be added."
}
POST /cards/{idCard}/labels
/cards/{idCard}/markAssociatedNotificationsRead
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
POST /cards/{idCard}/markAssociatedNotificationsRead
/cards/{idCard}/membersVoted
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_membersVoted"
}
}
},
"required": true,
"description": "Attributes of \"Cards Members Voted\" to be added."
}
POST /cards/{idCard}/membersVoted
/cards/{idCard}/stickers
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_stickers"
}
}
},
"required": true,
"description": "Attributes of \"Cards Stickers\" to be added."
}
POST /cards/{idCard}/stickers
/checklists
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/checklists"
}
}
},
"required": true,
"description": "Attributes of \"Checklists\" to be added."
}
POST /checklists
/checklists/{idChecklist}/checkItems
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/checklists_checkItems"
}
}
},
"required": true,
"description": "Attributes of \"Checklists Check Items\" to be added."
}
POST /checklists/{idChecklist}/checkItems
/labels
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/labels"
}
}
},
"required": true,
"description": "Attributes of \"Labels\" to be added."
}
POST /labels
/lists
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lists"
}
}
},
"required": true,
"description": "Attributes of \"Lists\" to be added."
}
POST /lists
/lists/{idList}/archiveAllCards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
POST /lists/{idList}/archiveAllCards
/lists/{idList}/cards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lists_cards"
}
}
},
"required": true,
"description": "Attributes of \"Lists Cards\" to be added."
}
POST /lists/{idList}/cards
/lists/{idList}/moveAllCards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lists_moveAllCards"
}
}
},
"required": true,
"description": "Attributes of \"Lists Move All Cards\" to be added."
}
POST /lists/{idList}/moveAllCards
/members/{idMember}/avatar
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_avatar"
}
}
},
"required": true,
"description": "Attributes of \"Members Avatar\" to be added."
}
POST /members/{idMember}/avatar
/members/{idMember}/boardBackgrounds
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_boardBackgrounds"
}
}
},
"required": true,
"description": "Attributes of \"Members Board Backgrounds\" to be added."
}
POST /members/{idMember}/boardBackgrounds
/members/{idMember}/boardStars
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_boardStars"
}
}
},
"required": true,
"description": "Attributes of \"Members Board Stars\" to be added."
}
POST /members/{idMember}/boardStars
/members/{idMember}/customBoardBackgrounds
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_customBoardBackgrounds"
}
}
},
"required": true,
"description": "Attributes of \"Members Custom Board Backgrounds\" to be added."
}
POST /members/{idMember}/customBoardBackgrounds
/members/{idMember}/customEmoji
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_customEmoji"
}
}
},
"required": true,
"description": "Attributes of \"Members Custom Emoji\" to be added."
}
POST /members/{idMember}/customEmoji
/members/{idMember}/customStickers
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_customStickers"
}
}
},
"required": true,
"description": "Attributes of \"Members Custom Stickers\" to be added."
}
POST /members/{idMember}/customStickers
/members/{idMember}/oneTimeMessagesDismissed
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_oneTimeMessagesDismissed"
}
}
},
"required": true,
"description": "Attributes of \"Members One Time Messages Dismissed\" to be added."
}
POST /members/{idMember}/oneTimeMessagesDismissed
/members/{idMember}/savedSearches
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_savedSearches"
}
}
},
"required": true,
"description": "Attributes of \"Members Saved Searches\" to be added."
}
POST /members/{idMember}/savedSearches
/notifications/all/read
POST /notifications/all/read
/organizations
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizations"
}
}
},
"required": true,
"description": "Attributes of \"Organizations\" to be added."
}
POST /organizations
/organizations/{idOrg}/logo
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizations_logo"
}
}
},
"required": true,
"description": "Attributes of \"Organizations Logo\" to be added."
}
POST /organizations/{idOrg}/logo
/sessions
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/sessions"
}
}
},
"required": true,
"description": "Attributes of \"Sessions\" to be added."
}
POST /sessions
/tokens/{token}/webhooks
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tokens_webhooks"
}
}
},
"required": true,
"description": "Attributes of \"Tokens Webhooks\" to be added."
}
POST /tokens/{token}/webhooks
actions
{
"xml": {
"name": "action"
},
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
actions_comments
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
actions_text
{
"xml": {
"name": "action"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"closed": {
"type": "string",
"description": " true or false"
},
"powerUps": {
"type": "string",
"description": "all or a comma-separated list of: calendar, cardAging, recap or voting"
},
"subscribed": {
"type": "string",
"description": " true or false"
},
"prefs/voting": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"prefs_voting": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"idBoardSource": {
"type": "string",
"description": "The id of the board to copy into the new board"
},
"idOrganization": {
"type": "string",
"description": "The id or name of the organization to add the board to."
},
"keepFromSource": {
"type": "string",
"description": "Components of the source board to copy."
},
"labelNames/red": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/comments": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"prefs/selfJoin": {
"type": "string",
"description": " true or false"
},
"prefs_comments": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"prefs_selfJoin": {
"type": "string",
"description": " true or false"
},
"labelNames/blue": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/cardAging": {
"type": "string",
"description": "One of: pirate or regular"
},
"prefs_cardAging": {
"type": "string",
"description": "One of: pirate or regular"
},
"labelNames/green": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/background": {
"type": "string",
"description": "A standard background name, or the id of a custom background"
},
"prefs/cardCovers": {
"type": "string",
"description": " true or false"
},
"prefs_background": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs_cardCovers": {
"type": "string",
"description": " true or false"
},
"labelNames/orange": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"labelNames/purple": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"labelNames/yellow": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/invitations": {
"type": "string",
"description": "One of: admins or members"
},
"prefs_invitations": {
"type": "string",
"description": "One of: admins or members"
},
"prefs/permissionLevel": {
"type": "string",
"description": "One of: org, private or public"
},
"prefs_permissionLevel": {
"type": "string",
"description": "One of: org, private or public"
},
"prefs/calendarFeedEnabled": {
"type": "string",
"description": " true or false"
}
}
}
boards_checklists
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards_closed
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
boards_desc
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
boards_idOrganization
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
boards_labels
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"color": {
"type": "string",
"description": "A valid label color or null"
}
}
}
boards_lists
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards_members
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"email": {
"type": "string",
"description": "An email address"
},
"fullName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
boards_memberships
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"member_fields": {
"type": "string",
"description": "all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"
}
}
}
boards_name
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards_powerUps
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: calendar, cardAging, recap or voting"
}
}
}
boards_subscribed
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
cards
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"due": {
"type": "string",
"description": "A date, or null"
},
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "The name of the new card. It isn't required if the name is being copied from provided by a URL, file or card that is being copied."
},
"closed": {
"type": "string",
"description": " true or false"
},
"idList": {
"type": "string",
"description": "id of the list that the card should be added to"
},
"labels": {
"type": "string",
"description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
},
"idBoard": {
"type": "string",
"description": "id of the board the card should be moved to"
},
"idLabels": {
"type": "string",
"description": "A comma-separated list of objectIds, 24-character hex strings"
},
"idMembers": {
"type": "string",
"description": "A comma-separated list of objectIds, 24-character hex strings"
},
"urlSource": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
},
"fileSource": {
"type": "string",
"description": "A file"
},
"subscribed": {
"type": "string",
"description": " true or false"
},
"idCardSource": {
"type": "string",
"description": "The id of the card to copy into a new card."
},
"keepFromSource": {
"type": "string",
"description": "Properties of the card to copy over from the source."
},
"idAttachmentCover": {
"type": "string",
"description": "Id of the image attachment of this card to use as its cover, or null for no cover"
}
}
}
cards_actions_comments
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_attachments
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
},
"file": {
"type": "string",
"description": "A file"
},
"name": {
"type": "string",
"description": "a string with a length from 0 to 256"
},
"mimeType": {
"type": "string",
"description": "a string with a length from 0 to 256"
}
}
}
cards_checklist_checkItem
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_checklist_checkItem_name
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_checklist_checkItem_pos
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
cards_checklist_checkItem_state
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: complete, false, incomplete or true"
}
}
}
cards_checklist_idChecklistCurrent_checkItem
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"state": {
"type": "string",
"description": "One of: complete, false, incomplete or true"
},
"idChecklist": {
"type": "string",
"description": "An id, or null"
}
}
}
cards_checklists
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"value": {
"type": "string",
"description": "The id of the checklist to add to the card, or null to create a new one."
},
"idChecklistSource": {
"type": "string",
"description": "The id of the source checklist to copy into a new checklist."
}
}
}
cards_closed
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
cards_desc
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
cards_due
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A date, or null"
}
}
}
cards_idAttachmentCover
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Id of the image attachment of this card to use as its cover, or null for no cover"
}
}
}
cards_idBoard
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "id of the board the card should be moved to"
},
"idList": {
"type": "string",
"description": "id of the list that the card should be moved to on the new board"
}
}
}
cards_idLabels
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the label to add"
}
}
}
cards_idList
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "id of the list the card should be moved to"
}
}
}
cards_idMembers
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the member to add to the card"
}
}
}
cards_labels
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"color": {
"type": "string",
"description": "A valid label color or null"
},
"value": {
"type": "string",
"description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
}
}
}
cards_membersVoted
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the member to vote 'yes' on the card"
}
}
}
cards_name
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_pos
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
cards_stickers
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"top": {
"type": "string",
"description": "undefined"
},
"left": {
"type": "string",
"description": "undefined"
},
"image": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"rotate": {
"type": "string",
"description": "undefined"
},
"zIndex": {
"type": "string",
"description": "Valid Z values for stickers, must be an integer"
}
}
}
cards_subscribed
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
checklists
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"idCard": {
"type": "string",
"description": "id of the card that the checklist should be added to"
},
"idBoard": {
"type": "string",
"description": "id of the board that the checklist should be added to"
},
"idChecklistSource": {
"type": "string",
"description": "The id of the source checklist to copy into a new checklist."
}
}
}
checklists_checkItems
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"checked": {
"type": "string",
"description": " true or false"
}
}
}
checklists_idCard
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the card that the checklist is on"
}
}
}
checklists_name
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
checklists_pos
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
labelNames_blue
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_green
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_orange
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_purple
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_red
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_yellow
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labels
{
"xml": {
"name": "label"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"color": {
"type": "string",
"description": "A valid label color or null"
},
"idBoard": {
"type": "string",
"description": "An id"
}
}
}
labels_color
{
"xml": {
"name": "label"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A valid label color or null"
}
}
}
labels_name
{
"xml": {
"name": "label"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
lists
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"closed": {
"type": "string",
"description": " true or false"
},
"idBoard": {
"type": "string",
"description": "id of the board that the list should be added to"
},
"subscribed": {
"type": "string",
"description": " true or false"
},
"idListSource": {
"type": "string",
"description": "The id of the list to copy into a new list."
}
}
}
lists_cards
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"due": {
"type": "string",
"description": "A date, or null"
},
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"labels": {
"type": "string",
"description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
},
"idMembers": {
"type": "string",
"description": "A comma-separated list of objectIds, 24-character hex strings"
}
}
}
lists_closed
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
lists_idBoard
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "position of the list on the new board"
},
"value": {
"type": "string",
"description": "id of the board the list should be moved to"
}
}
}
lists_moveAllCards
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"idBoard": {
"type": "string",
"description": "id of the board that the cards should be moved to"
}
}
}
lists_name
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
lists_pos
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
lists_subscribed
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
members
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"bio": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"fullName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
},
"initials": {
"type": "string",
"description": "A string with a length from 1 to 4. Cannot begin or end with a space"
},
"username": {
"type": "string",
"description": "A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique."
},
"avatarSource": {
"type": "string",
"description": "One of: gravatar, none or upload"
},
"prefs/locale": {
"type": "string",
"description": "a string with a length from 0 to 255"
},
"prefs/colorBlind": {
"type": "string",
"description": " true or false"
},
"prefs/minutesBetweenSummaries": {
"type": "string",
"description": "-1 (disabled), 1 or 60"
}
}
}
members_avatar
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
}
}
}
members_avatarSource
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: gravatar, none or upload"
}
}
}
members_bio
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
members_boardBackgrounds
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
},
"tile": {
"type": "string",
"description": " true or false"
},
"brightness": {
"type": "string",
"description": "One of: dark, light or unknown"
}
}
}
members_boardStars
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"idBoard": {
"type": "string",
"description": "The id of the board to star"
}
}
}
members_boardStars_idBoard
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "An id"
}
}
}
members_boardStars_pos
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
members_customBoardBackgrounds
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
},
"tile": {
"type": "string",
"description": " true or false"
},
"brightness": {
"type": "string",
"description": "One of: dark, light or unknown"
}
}
}
members_customEmoji
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
},
"name": {
"type": "string",
"description": "a string with a length from 2 to 64"
}
}
}
members_customStickers
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
}
}
}
members_fullName
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
members_initials
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length from 1 to 4. Cannot begin or end with a space"
}
}
}
members_oneTimeMessagesDismissed
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Type of message dismissed"
}
}
}
members_savedSearches
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "A non-empty string with at least one non-space character"
},
"query": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
members_savedSearches_name
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A non-empty string with at least one non-space character"
}
}
}
members_savedSearches_pos
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
members_savedSearches_query
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
members_username
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique."
}
}
}
myPrefs_emailPosition
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: bottom or top"
}
}
}
myPrefs_idEmailList
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "An id"
}
}
}
myPrefs_showListGuide
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebar
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebarActivity
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebarBoardActions
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebarMembers
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
notifications
{
"xml": {
"name": "notification"
},
"type": "object",
"properties": {
"unread": {
"type": "string",
"description": " true or false"
}
}
}
notifications_unread
{
"xml": {
"name": "notification"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
organizations
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"website": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
},
"displayName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
},
"prefs/permissionLevel": {
"type": "string",
"description": "One of: private or public"
},
"prefs/associatedDomain": {
"type": "string",
"description": "The google apps domain to link this org to."
},
"prefs/googleAppsVersion": {
"type": "string",
"description": "a number from 1 to 2"
},
"prefs/orgInviteRestrict": {
"type": "string",
"description": "An email address with optional expansion tokens"
},
"prefs/externalMembersDisabled": {
"type": "string",
"description": " true or false"
},
"prefs/boardVisibilityRestrict/org": {
"type": "string",
"description": "One of: admin, none or org"
},
"prefs/boardVisibilityRestrict/public": {
"type": "string",
"description": "One of: admin, none or org"
},
"prefs/boardVisibilityRestrict/private": {
"type": "string",
"description": "One of: admin, none or org"
}
}
}
organizations_desc
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
organizations_displayName
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
organizations_logo
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
}
}
}
organizations_members
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"email": {
"type": "string",
"description": "An email address"
},
"fullName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
organizations_members_deactivated
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
organizations_memberships
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"member_fields": {
"type": "string",
"description": "all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"
}
}
}
organizations_name
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique."
}
}
}
organizations_website
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
}
}
}
prefs_associatedDomain
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The google apps domain to link this org to."
}
}
}
prefs_background
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A standard background name, or the id of a custom background"
}
}
}
prefs_boardVisibilityRestrict
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: admin, none or org"
}
}
}
prefs_calendarFeedEnabled
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_cardAging
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: pirate or regular"
}
}
}
prefs_cardCovers
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_colorBlind
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_comments
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
}
}
}
prefs_externalMembersDisabled
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_googleAppsVersion
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a number from 1 to 2"
}
}
}
prefs_invitations
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: admins or members"
}
}
}
prefs_locale
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 255"
}
}
}
prefs_minutesBetweenSummaries
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "-1 (disabled), 1 or 60"
}
}
}
prefs_orgInviteRestrict
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "An email address with optional expansion tokens"
}
}
}
prefs_permissionLevel
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: private or public"
}
}
}
prefs_selfJoin
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_voting
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
}
}
}
sessions
{
"xml": {
"name": "session"
},
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "One of: active, disconnected or idle"
},
"idBoard": {
"type": "string",
"description": "The id of the board you're viewing. Boards with no viewers will not get updates about members' statuses."
}
}
}
sessions_status
{
"xml": {
"name": "session"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: active, disconnected or idle"
}
}
}
tokens_webhooks
{
"xml": {
"name": "token"
},
"type": "object",
"properties": {
"idModel": {
"type": "string",
"description": "id of the model to be monitored"
},
"callbackURL": {
"type": "string",
"description": "A valid URL that is reachable with a HEAD request"
},
"description": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
webhooks
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"active": {
"type": "string",
"description": " true or false"
},
"idModel": {
"type": "string",
"description": "id of the model that should be hooked"
},
"callbackURL": {
"type": "string",
"description": "A valid URL that is reachable with a HEAD request"
},
"description": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
webhooks_active
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
webhooks_callbackURL
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A valid URL that is reachable with a HEAD request"
}
}
}
webhooks_description
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
webhooks_idModel
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "id of the model to be monitored"
}
}
}