[
{
"handle": "boards",
"meta": {
"short": "Boards",
"description": "Represents a board in Trello, which contains lists and cards."
},
"endpoint": {
"value": "/boards/{{boardId}}",
"placeholders": [
{
"name": "boardId",
"type": "String",
"description": "The ID of the board",
"required": true
}
]
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {
"description": "The unique identifier for the board"
}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {
"description": "The name of the board"
}
},
{
"name": "description",
"type": "String",
"selector": ["desc"],
"meta": {
"description": "The description of the board"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "/members/{{memberId}}/boards",
"placeholders": [
{
"name": "memberId",
"type": "String",
"description": "The ID of the member",
"required": true
}
]
},
"queryParams": {
"fields": "name,desc",
"filter": "open"
}
},
"read": {
"method": "GET",
"path": {
"value": "/boards/{{boardId}}",
"placeholders": [
{
"name": "boardId",
"type": "String",
"description": "The ID of the board",
"required": true
}
]
},
"queryParams": {
"fields": "name,desc"
}
},
"create": {
"method": "POST",
"path": {
"value": "/boards"
},
"bodyTemplate": {
"value": "{\"name\": \"{{name}}\", \"defaultLists\": {{defaultLists}}, \"desc\": \"{{description}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the board",
"required": true
},
{
"name": "defaultLists",
"type": "Boolean",
"description": "Whether to create default lists",
"required": false,
"default": "true"
},
{
"name": "description",
"type": "String",
"description": "The description of the board",
"required": false
}
]
}
},
"update": {
"method": "PUT",
"path": {
"value": "/boards/{{boardId}}",
"placeholders": [
{
"name": "boardId",
"type": "String",
"description": "The ID of the board",
"required": true
}
]
},
"bodyTemplate": {
"value": "{\"name\": \"{{name}}\", \"desc\": \"{{description}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the board",
"required": false
},
{
"name": "description",
"type": "String",
"description": "The description of the board",
"required": false
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/boards/{{boardId}}",
"placeholders": [
{
"name": "boardId",
"type": "String",
"description": "The ID of the board",
"required": true
}
]
}
}
},
"webhooks": [
{
"event": "boardCreated",
"path": "/webhooks/trello/boardCreated",
"payload": [
{
"name": "boardId",
"type": "String",
"selector": ["action", "data", "board", "id"],
"meta": {
"description": "The ID of the board that was created"
}
},
{
"name": "boardName",
"type": "String",
"selector": ["action", "data", "board", "name"],
"meta": {
"description": "The name of the board that was created"
}
}
]
}
]
},
{
"handle": "lists",
"meta": {
"short": "Lists",
"description": "Represents a list on a Trello board, which contains cards."
},
"endpoint": {
"value": "/lists/{{listId}}",
"placeholders": [
{
"name": "listId",
"type": "String",
"description": "The ID of the list",
"required": true
}
]
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {
"description": "The unique identifier for the list"
}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {
"description": "The name of the list"
}
},
{
"name": "closed",
"type": "Boolean",
"selector": ["closed"],
"meta": {
"description": "Whether the list is closed"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "/boards/{{boardId}}/lists",
"placeholders": [
{
"name": "boardId",
"type": "String",
"description": "The ID of the board",
"required": true
}
]
},
"queryParams": {
"fields": "name,closed"
}
},
"read": {
"method": "GET",
"path": {
"value": "/lists/{{listId}}",
"placeholders": [
{
"name": "listId",
"type": "String",
"description": "The ID of the list",
"required": true
}
]
},
"queryParams": {
"fields": "name,closed"
}
},
"create": {
"method": "POST",
"path": {
"value": "/lists"
},
"bodyTemplate": {
"value": "{\"name\": \"{{name}}\", \"idBoard\": \"{{boardId}}\", \"pos\": \"{{position}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the list",
"required": true
},
{
"name": "boardId",
"type": "String",
"description": "The ID of the board",
"required": true
},
{
"name": "position",
"type": "String",
"description": "The position of the list",
"required": false,
"default": "bottom"
}
]
}
},
"update": {
"method": "PUT",
"path": {
"value": "/lists/{{listId}}",
"placeholders": [
{
"name": "listId",
"type": "String",
"description": "The ID of the list",
"required": true
}
]
},
"bodyTemplate": {
"value": "{\"name\": \"{{name}}\", \"closed\": {{closed}}}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the list",
"required": false
},
{
"name": "closed",
"type": "Boolean",
"description": "Whether the list is closed",
"required": false
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/lists/{{listId}}",
"placeholders": [
{
"name": "listId",
"type": "String",
"description": "The ID of the list",
"required": true
}
]
},
"queryParams": {
"value": true
}
}
},
"webhooks": [
{
"event": "listCreated",
"path": "/webhooks/trello/listCreated",
"payload": [
{
"name": "listId",
"type": "String",
"selector": ["action", "data", "list", "id"],
"meta": {
"description": "The ID of the list that was created"
}
},
{
"name": "listName",
"type": "String",
"selector": ["action", "data", "list", "name"],
"meta": {
"description": "The name of the list that was created"
}
}
]
}
]
},
{
"handle": "cards",
"meta": {
"short": "Cards",
"description": "Represents a card on a Trello list."
},
"endpoint": {
"value": "/cards/{{cardId}}",
"placeholders": [
{
"name": "cardId",
"type": "String",
"description": "The ID of the card",
"required": true
}
]
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {
"description": "The unique identifier for the card"
}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {
"description": "The name of the card"
}
},
{
"name": "description",
"type": "String",
"selector": ["desc"],
"meta": {
"description": "The description of the card"
}
},
{
"name": "due",
"type": "String",
"selector": ["due"],
"meta": {
"description": "The due date of the card"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "/lists/{{listId}}/cards",
"placeholders": [
{
"name": "listId",
"type": "String",
"description": "The ID of the list",
"required": true
}
]
},
"queryParams": {
"fields": "name,desc,due"
}
},
"read": {
"method": "GET",
"path": {
"value": "/cards/{{cardId}}",
"placeholders": [
{
"name": "cardId",
"type": "String",
"description": "The ID of the card",
"required": true
}
]
},
"queryParams": {
"fields": "name,desc,due"
}
},
"create": {
"method": "POST",
"path": {
"value": "/cards"
},
"bodyTemplate": {
"value": "{\"name\": \"{{name}}\", \"idList\": \"{{listId}}\", \"desc\": \"{{description}}\", \"due\": \"{{dueDate}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the card",
"required": true
},
{
"name": "listId",
"type": "String",
"description": "The ID of the list",
"required": true
},
{
"name": "description",
"type": "String",
"description": "The description of the card",
"required": false
},
{
"name": "dueDate",
"type": "String",
"description": "The due date of the card",
"required": false
}
]
}
},
"update": {
"method": "PUT",
"path": {
"value": "/cards/{{cardId}}",
"placeholders": [
{
"name": "cardId",
"type": "String",
"description": "The ID of the card",
"required": true
}
]
},
"bodyTemplate": {
"value": "{\"name\": \"{{name}}\", \"desc\": \"{{description}}\", \"due\": \"{{dueDate}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the card",
"required": false
},
{
"name": "description",
"type": "String",
"description": "The description of the card",
"required": false
},
{
"name": "dueDate",
"type": "String",
"description": "The due date of the card",
"required": false
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/cards/{{cardId}}",
"placeholders": [
{
"name": "cardId",
"type": "String",
"description": "The ID of the card",
"required": true
}
]
}
}
},
"webhooks": [
{
"event": "cardCreated",
"path": "/webhooks/trello/cardCreated",
"payload": [
{
"name": "cardId",
"type": "String",
"selector": ["action", "data", "card", "id"],
"meta": {
"description": "The ID of the card that was created"
}
},
{
"name": "cardName",
"type": "String",
"selector": ["action", "data", "card", "name"],
"meta": {
"description": "The name of the card that was created"
}
}
]
}
]
}
]