trello
Trello is a web-based, kanban-style, list-making application that allows users to organize tasks, projects, and workflows using boards, lists, and cards.
APIs
Trello REST API
The Trello REST API provides programmatic access to Trello boards, lists, cards, members, labels, checklists, and other resources that make up the Trello project management plat...
Trello Webhooks API
The Trello Webhooks API allows developers to receive real-time notifications when changes occur on Trello models such as boards, lists, and cards. Rather than polling the REST A...
Trello Power-Ups
Trello Power-Ups are a framework for extending and integrating with the Trello platform. Power-Ups allow developers to add custom functionality to Trello boards, including custo...
Collections
Trello REST API
OPENGraphQL
Trello GraphQL Schema
This document describes a conceptual GraphQL schema for the Trello API. Trello exposes a REST API at `https://api.trello.com/1/` with key/token authentication. This GraphQL sche...
GRAPHQLPricing Plans
Rate Limits
FinOps
Trello Finops
FINOPSFeatures
Event Specifications
Trello Webhooks Events
The Trello Webhooks API delivers real-time notifications when changes occur on Trello models such as boards, lists, cards, and members. Rather than polling the REST API for upda...
ASYNCAPISemantic Vocabularies
API Governance Rules
JSON Structure
Resources
Sources
opencollection: 1.0.0
info:
name: Trello REST API
version: '1'
request:
auth:
type: apikey
key: key
value: '{{key}}'
placement: query
items:
- info:
name: Actions
type: folder
items:
- info:
name: Get an Action
type: http
http:
method: GET
url: https://api.trello.com/1/actions/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves a single action by its identifier. Actions represent events that have occurred on Trello objects.
- info:
name: Update an Action
type: http
http:
method: PUT
url: https://api.trello.com/1/actions/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: text
value: ''
type: query
description: The new text for the comment action.
docs: Updates the text of a comment action. Only comment actions can be updated.
- info:
name: Delete an Action
type: http
http:
method: DELETE
url: https://api.trello.com/1/actions/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Deletes a comment action. Only comment actions can be deleted.
- info:
name: Get a specific field of an Action
type: http
http:
method: GET
url: https://api.trello.com/1/actions/:id/:field
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: field
value: ''
type: path
description: The field to retrieve from the action.
docs: Retrieves a single field value from an action.
- info:
name: Get the Board for an Action
type: http
http:
method: GET
url: https://api.trello.com/1/actions/:id/board
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves the board associated with a given action.
- info:
name: Get the Card for an Action
type: http
http:
method: GET
url: https://api.trello.com/1/actions/:id/card
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves the card associated with a given action.
- info:
name: Get the List for an Action
type: http
http:
method: GET
url: https://api.trello.com/1/actions/:id/list
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves the list associated with a given action.
- info:
name: Get the Member of an Action
type: http
http:
method: GET
url: https://api.trello.com/1/actions/:id/member
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves the member who was the subject of a given action.
- info:
name: Get the Member Creator of an Action
type: http
http:
method: GET
url: https://api.trello.com/1/actions/:id/memberCreator
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves the member who created a given action.
- info:
name: Get the Organization for an Action
type: http
http:
method: GET
url: https://api.trello.com/1/actions/:id/organization
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves the organization (workspace) associated with a given action.
- info:
name: List Reactions for an Action
type: http
http:
method: GET
url: https://api.trello.com/1/actions/:id/reactions
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves all emoji reactions on a given action.
- info:
name: Create a Reaction for an Action
type: http
http:
method: POST
url: https://api.trello.com/1/actions/:id/reactions
params:
- name: id
value: ''
type: path
description: The ID of the resource.
body:
type: json
data: '{}'
docs: Adds an emoji reaction to an action.
- info:
name: Boards
type: folder
items:
- info:
name: Create a Board
type: http
http:
method: POST
url: https://api.trello.com/1/boards
params:
- name: name
value: ''
type: query
description: The name for the new board.
- name: defaultLabels
value: ''
type: query
description: Whether to apply the default set of labels to the board.
- name: defaultLists
value: ''
type: query
description: Whether to add the default set of lists to the board.
- name: desc
value: ''
type: query
description: A description for the board.
- name: idOrganization
value: ''
type: query
description: The ID or name of the organization (workspace) the board should belong to.
- name: idBoardSource
value: ''
type: query
description: The ID of a board to copy into the new board.
- name: prefs_permissionLevel
value: ''
type: query
description: The permissions level of the board.
- name: prefs_voting
value: ''
type: query
description: Who can vote on the board.
- name: prefs_comments
value: ''
type: query
description: Who can comment on cards on the board.
- name: prefs_background
value: ''
type: query
description: The background color or image for the board.
- name: prefs_cardAging
value: ''
type: query
description: The style of card aging to apply to the board.
- name: prefs_selfJoin
value: ''
type: query
description: Whether workspace members can join the board themselves.
docs: Creates a new Trello board with the specified name and optional settings such as description, organization, permission
level, and initial configuration.
- info:
name: Get a Board
type: http
http:
method: GET
url: https://api.trello.com/1/boards/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: actions
value: ''
type: query
description: A comma-separated list of action types to include.
- name: boardStars
value: ''
type: query
description: Whether to include board stars.
- name: cards
value: ''
type: query
description: Filter cards to include.
- name: card_fields
value: ''
type: query
description: A comma-separated list of card fields to include.
- name: checklists
value: ''
type: query
description: Whether to include checklists.
- name: fields
value: ''
type: query
description: A comma-separated list of board fields to include.
- name: labels
value: ''
type: query
description: Whether to include labels.
- name: lists
value: ''
type: query
description: Filter lists to include.
- name: members
value: ''
type: query
description: Whether to include members.
- name: memberships
value: ''
type: query
description: Whether to include memberships.
- name: organization
value: ''
type: query
description: Whether to include the organization.
docs: Retrieves a single board by its identifier, including its fields and optionally nested resources.
- info:
name: Update a Board
type: http
http:
method: PUT
url: https://api.trello.com/1/boards/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: name
value: ''
type: query
description: The new name for the board.
- name: desc
value: ''
type: query
description: The new description for the board.
- name: closed
value: ''
type: query
description: Whether the board is closed (archived).
- name: subscribed
value: ''
type: query
description: Whether the authenticated member is subscribed to the board.
- name: idOrganization
value: ''
type: query
description: The ID of the organization to move the board to.
- name: prefs/permissionLevel
value: ''
type: query
description: The permission level for the board.
- name: prefs/selfJoin
value: ''
type: query
description: Whether workspace members can join the board themselves.
- name: prefs/cardCovers
value: ''
type: query
description: Whether card covers are enabled.
- name: prefs/hideVotes
value: ''
type: query
description: Whether votes are hidden until voting is complete.
- name: prefs/background
value: ''
type: query
description: The background for the board.
- name: prefs/cardAging
value: ''
type: query
description: The card aging style.
- name: labelNames/green
value: ''
type: query
description: Name for the green label.
- name: labelNames/yellow
value: ''
type: query
description: Name for the yellow label.
- name: labelNames/orange
value: ''
type: query
description: Name for the orange label.
- name: labelNames/red
value: ''
type: query
description: Name for the red label.
- name: labelNames/purple
value: ''
type: query
description: Name for the purple label.
- name: labelNames/blue
value: ''
type: query
description: Name for the blue label.
docs: Updates a board's fields, including name, description, preferences, and organizational settings.
- info:
name: Delete a Board
type: http
http:
method: DELETE
url: https://api.trello.com/1/boards/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Permanently deletes a board. This action cannot be undone.
- info:
name: Get Actions for a Board
type: http
http:
method: GET
url: https://api.trello.com/1/boards/:id/actions
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: filter
value: ''
type: query
description: A comma-separated list of action types to filter by.
- name: limit
value: ''
type: query
description: The maximum number of actions to return.
docs: Retrieves a list of actions (activity events) associated with a board.
- info:
name: Get Cards on a Board
type: http
http:
method: GET
url: https://api.trello.com/1/boards/:id/cards
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: fields
value: ''
type: query
description: A comma-separated list of card fields to return.
docs: Retrieves all cards on a board, with optional filtering.
- info:
name: Get Filtered Cards on a Board
type: http
http:
method: GET
url: https://api.trello.com/1/boards/:id/cards/:filter
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: filter
value: ''
type: path
description: The filter to apply to the cards.
docs: Retrieves cards on a board filtered by status.
- info:
name: Get Checklists on a Board
type: http
http:
method: GET
url: https://api.trello.com/1/boards/:id/checklists
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves all checklists on a board.
- info:
name: Get Labels on a Board
type: http
http:
method: GET
url: https://api.trello.com/1/boards/:id/labels
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: fields
value: ''
type: query
description: A comma-separated list of label fields to return.
- name: limit
value: ''
type: query
description: Maximum number of labels to return.
docs: Retrieves all labels defined on a board.
- info:
name: Create a Label on a Board
type: http
http:
method: POST
url: https://api.trello.com/1/boards/:id/labels
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: name
value: ''
type: query
description: The name for the label.
- name: color
value: ''
type: query
description: The color for the label.
docs: Creates a new label on a board.
- info:
name: Get Lists on a Board
type: http
http:
method: GET
url: https://api.trello.com/1/boards/:id/lists
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: cards
value: ''
type: query
description: Filter cards within lists.
- name: card_fields
value: ''
type: query
description: A comma-separated list of card fields to return.
- name: filter
value: ''
type: query
description: Filter lists by status.
- name: fields
value: ''
type: query
description: A comma-separated list of list fields to return.
docs: Retrieves all lists on a board, with optional filtering.
- info:
name: Create a List on a Board
type: http
http:
method: POST
url: https://api.trello.com/1/boards/:id/lists
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: name
value: ''
type: query
description: The name for the new list.
- name: pos
value: ''
type: query
description: The position of the list on the board.
docs: Creates a new list on the specified board.
- info:
name: Get Members of a Board
type: http
http:
method: GET
url: https://api.trello.com/1/boards/:id/members
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves the members associated with a board.
- info:
name: Invite a Member to a Board
type: http
http:
method: PUT
url: https://api.trello.com/1/boards/:id/members
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: email
value: ''
type: query
description: The email address of the member to invite.
- name: type
value: ''
type: query
description: The type of membership.
docs: Invites a member to a board via email.
- info:
name: Update a Board Member
type: http
http:
method: PUT
url: https://api.trello.com/1/boards/:id/members/:idMember
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: idMember
value: ''
type: path
description: The ID of the member to update.
- name: type
value: ''
type: query
description: The new membership type.
docs: Updates the membership type for a member on a board.
- info:
name: Remove a Member from a Board
type: http
http:
method: DELETE
url: https://api.trello.com/1/boards/:id/members/:idMember
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: idMember
value: ''
type: path
description: The ID of the member to remove.
docs: Removes a member from a board.
- info:
name: Get Memberships of a Board
type: http
http:
method: GET
url: https://api.trello.com/1/boards/:id/memberships
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: filter
value: ''
type: query
description: Filter memberships by type.
docs: Retrieves the membership records for a board, including membership type and member references.
- info:
name: Cards
type: folder
items:
- info:
name: Create a Card
type: http
http:
method: POST
url: https://api.trello.com/1/cards
params:
- name: name
value: ''
type: query
description: The name for the card.
- name: desc
value: ''
type: query
description: The description for the card.
- name: pos
value: ''
type: query
description: The position of the card in the list.
- name: due
value: ''
type: query
description: The due date for the card.
- name: start
value: ''
type: query
description: The start date for the card.
- name: dueComplete
value: ''
type: query
description: Whether the due date is complete.
- name: idList
value: ''
type: query
description: The ID of the list the card should be created in.
- name: idMembers
value: ''
type: query
description: Comma-separated list of member IDs to add to the card.
- name: idLabels
value: ''
type: query
description: Comma-separated list of label IDs to add to the card.
- name: urlSource
value: ''
type: query
description: A URL to attach to the card.
- name: idCardSource
value: ''
type: query
description: The ID of a card to copy into the new card.
docs: Creates a new card on the specified list.
- info:
name: Get a Card
type: http
http:
method: GET
url: https://api.trello.com/1/cards/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: fields
value: ''
type: query
description: A comma-separated list of card fields to return.
- name: actions
value: ''
type: query
description: A comma-separated list of action types to include.
- name: attachments
value: ''
type: query
description: Whether to include attachments.
- name: members
value: ''
type: query
description: Whether to include members.
- name: checkItemStates
value: ''
type: query
description: Whether to include check item states.
- name: checklists
value: ''
type: query
description: Whether to include checklists.
docs: Retrieves a single card by its identifier.
- info:
name: Update a Card
type: http
http:
method: PUT
url: https://api.trello.com/1/cards/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: name
value: ''
type: query
description: The new name for the card.
- name: desc
value: ''
type: query
description: The new description for the card.
- name: closed
value: ''
type: query
description: Whether the card is archived.
- name: idMembers
value: ''
type: query
description: Comma-separated list of member IDs.
- name: idLabels
value: ''
type: query
description: Comma-separated list of label IDs.
- name: idList
value: ''
type: query
description: The ID of the list to move the card to.
- name: idBoard
value: ''
type: query
description: The ID of the board to move the card to.
- name: pos
value: ''
type: query
description: The new position of the card.
- name: due
value: ''
type: query
description: The new due date for the card.
- name: start
value: ''
type: query
description: The start date for the card.
- name: dueComplete
value: ''
type: query
description: Whether the due date is complete.
- name: subscribed
value: ''
type: query
description: Whether the authenticated member is subscribed to the card.
- name: cover
value: ''
type: query
description: JSON string for the card cover.
docs: Updates the fields of a card, including name, description, position, due date, list assignment, and more.
- info:
name: Delete a Card
type: http
http:
method: DELETE
url: https://api.trello.com/1/cards/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Permanently deletes a card. This action cannot be undone.
- info:
name: Get Actions on a Card
type: http
http:
method: GET
url: https://api.trello.com/1/cards/:id/actions
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: filter
value: ''
type: query
description: A comma-separated list of action types to filter by.
docs: Retrieves a list of actions (activity events) on a card.
- info:
name: Add a Comment to a Card
type: http
http:
method: POST
url: https://api.trello.com/1/cards/:id/actions/comments
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: text
value: ''
type: query
description: The comment text.
docs: Adds a new comment to a card.
- info:
name: Get Attachments on a Card
type: http
http:
method: GET
url: https://api.trello.com/1/cards/:id/attachments
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: fields
value: ''
type: query
description: A comma-separated list of attachment fields to return.
docs: Retrieves all attachments on a card.
- info:
name: Create an Attachment on a Card
type: http
http:
method: POST
url: https://api.trello.com/1/cards/:id/attachments
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: name
value: ''
type: query
description: The name for the attachment.
- name: mimeType
value: ''
type: query
description: The MIME type of the attachment.
- name: url
value: ''
type: query
description: A URL to attach to the card.
docs: Adds a new attachment to a card, either from a URL or a file upload.
- info:
name: Get Checklists on a Card
type: http
http:
method: GET
url: https://api.trello.com/1/cards/:id/checklists
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves all checklists on a card.
- info:
name: Create a Checklist on a Card
type: http
http:
method: POST
url: https://api.trello.com/1/cards/:id/checklists
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: name
value: ''
type: query
description: The name for the checklist.
- name: idChecklistSource
value: ''
type: query
description: The ID of a checklist to copy into the new checklist.
- name: pos
value: ''
type: query
description: The position of the checklist on the card.
docs: Creates a new checklist on the specified card.
- info:
name: Add a Label to a Card
type: http
http:
method: POST
url: https://api.trello.com/1/cards/:id/labels
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: value
value: ''
type: query
description: The ID of the label to add.
docs: Adds an existing label to a card.
- info:
name: Remove a Label from a Card
type: http
http:
method: DELETE
url: https://api.trello.com/1/cards/:id/labels/:idLabel
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: idLabel
value: ''
type: path
description: The ID of the label to remove.
docs: Removes a label from a card.
- info:
name: Add a Member to a Card
type: http
http:
method: POST
url: https://api.trello.com/1/cards/:id/members
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: value
value: ''
type: query
description: The ID of the member to add.
docs: Adds a member to a card.
- info:
name: Remove a Member from a Card
type: http
http:
method: DELETE
url: https://api.trello.com/1/cards/:id/members/:idMember
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: idMember
value: ''
type: path
description: The ID of the member to remove.
docs: Removes a member from a card.
- info:
name: Get Stickers on a Card
type: http
http:
method: GET
url: https://api.trello.com/1/cards/:id/stickers
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Retrieves all stickers on a card.
- info:
name: Add a Sticker to a Card
type: http
http:
method: POST
url: https://api.trello.com/1/cards/:id/stickers
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: image
value: ''
type: query
description: The sticker image identifier.
- name: top
value: ''
type: query
description: The top position of the sticker as a percentage.
- name: left
value: ''
type: query
description: The left position of the sticker as a percentage.
- name: zIndex
value: ''
type: query
description: The z-index of the sticker.
- name: rotate
value: ''
type: query
description: The rotation of the sticker in degrees.
docs: Adds a sticker to a card.
- info:
name: Checklists
type: folder
items:
- info:
name: Create a Checklist
type: http
http:
method: POST
url: https://api.trello.com/1/checklists
params:
- name: idCard
value: ''
type: query
description: The ID of the card the checklist should be on.
- name: name
value: ''
type: query
description: The name of the checklist.
- name: pos
value: ''
type: query
description: The position of the checklist on the card.
- name: idChecklistSource
value: ''
type: query
description: The ID of a source checklist to copy.
docs: Creates a new checklist, optionally on a specific card.
- info:
name: Get a Checklist
type: http
http:
method: GET
url: https://api.trello.com/1/checklists/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: cards
value: ''
type: query
description: Filter cards to include.
- name: checkItems
value: ''
type: query
description: Whether to include check items.
- name: checkItem_fields
value: ''
type: query
description: A comma-separated list of check item fields to return.
- name: fields
value: ''
type: query
description: A comma-separated list of checklist fields to return.
docs: Retrieves a single checklist by its identifier.
- info:
name: Update a Checklist
type: http
http:
method: PUT
url: https://api.trello.com/1/checklists/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: name
value: ''
type: query
description: The new name for the checklist.
- name: pos
value: ''
type: query
description: The new position for the checklist.
docs: Updates a checklist's name or position.
- info:
name: Delete a Checklist
type: http
http:
method: DELETE
url: https://api.trello.com/1/checklists/:id
params:
- name: id
value: ''
type: path
description: The ID of the resource.
docs: Permanently deletes a checklist.
- info:
name: Get Check Items on a Checklist
type: http
http:
method: GET
url: https://api.trello.com/1/checklists/:id/checkItems
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: filter
value: ''
type: query
description: Filter check items by state.
- name: fields
value: ''
type: query
description: A comma-separated list of check item fields to return.
docs: Retrieves all check items on a checklist.
- info:
name: Create a Check Item on a Checklist
type: http
http:
method: POST
url: https://api.trello.com/1/checklists/:id/checkItems
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: name
value: ''
type: query
description: The name of the check item.
- name: pos
value: ''
type: query
description: The position of the check item in the checklist.
- name: checked
value: ''
type: query
description: Whether the check item is initially checked.
- name: due
value: ''
type: query
description: A due date for the check item.
- name: idMember
value: ''
type: query
description: The ID of a member to assign to the check item.
docs: Creates a new check item on a checklist.
- info:
name: Get a Check Item on a Checklist
type: http
http:
method: GET
url: https://api.trello.com/1/checklists/:id/checkItems/:idCheckItem
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: idCheckItem
value: ''
type: path
description: The ID of the check item.
docs: Retrieves a specific check item on a checklist.
- info:
name: Delete a Check Item from a Checklist
type: http
http:
method: DELETE
url: https://api.trello.com/1/checklists/:id/checkItems/:idCheckItem
params:
- name: id
value: ''
type: path
description: The ID of the resource.
- name: idCheckItem
value: ''
type: path
description: The ID of the check item to delete.
docs: Removes a check item from a checklist.
- info:
name: CustomFields
type: folder
items:
- info:
name: Create a Custom Field Definition
type: http
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/trello/refs/heads/main/apis.yml