1. Overview
Trello is a popular project management and collaboration tool based on the Kanban method. It helps teams and individuals organize tasks, track progress, and collaborate efficiently through a visual format of boards, lists, and cards.
With GoInsight's Trello node, you can seamlessly integrate powerful project management capabilities into your automated workflows. You can manage the entire lifecycle of core resources in Trello, including:
- Board Management: Create, update, delete, and get detailed information for boards.
- List and Card Operations: Create, move, and manage lists on a board; create, update, delete, and query cards within lists.
- Member Collaboration: Add, remove, and invite members to boards for dynamic team management.
- Task Detailing: Add comments, attachments, labels, checklists, and checkitems to cards for fine-grained task tracking.
- Global Search: Search for boards, cards, and members across your Trello account.
2. Prerequisites
Before using this node, you must have a valid Trello account. You may need administrator or specific permissions to create and manage API credentials.
3. Credentials
For a detailed guide on how to obtain and configure credentials, please refer to our official documentation: Credential Configuration Guide.
4. Supported Operations
Summary
This Trello node primarily operates on boards, lists, cards, members, and their related sub-resources (such as attachments, comments, labels, etc.). The table below summarizes all supported operations:
Resource | Operation | Description |
---|---|---|
Board | Create a Board | Creates a new Trello board with optional settings like description and organization. |
Board | Get Board Data | Retrieves comprehensive data for a board by its ID, including lists, cards, members, and settings. |
Board | Update a Board | Updates the properties of an existing Trello board, such as name, description, and permissions. |
Board | Delete Board | Permanently deletes a Trello board and all its content by its ID. |
Board Member | Add Board Member | Adds a member to a specified Trello board and sets their role type. |
Board Member | Get Board Members | Retrieves all members of a specified Trello board and their details. |
Board Member | Invite Member To Join a Board | Invites a new member to join a Trello board via email. |
Board Member | Remove Board Member | Removes a member from a specified Trello board. |
List | Create a List | Creates a new list on a specified Trello board. |
List | Get All Lists | Retrieves all lists on a specified Trello board. |
List | Get List Data | Gets detailed data for a list by its ID, including all its cards. |
List | Update a List | Updates the properties of a Trello list, such as name, position, or subscribed status. |
List | Archive or Unarchive a List | Archives or unarchives a Trello list to hide or show it. |
Card | Create a Card | Creates a new card in a specified Trello list. |
Card | Get a Card | Retrieves detailed information for a card by its ID. |
Card | Get List Cards | Gets all cards in a specified Trello list. |
Card | Update a Card | Updates the properties of a Trello card, such as name, description, and due date. |
Card | Delete Card | Permanently deletes one or more Trello cards by their ID(s). |
Card Attachment | Create Card Attachment | Creates a new URL attachment for a specified Trello card. |
Card Attachment | Get Card Attachments | Retrieves all attachments on a specified Trello card. |
Card Attachment | Delete Attachment | Deletes a specified attachment from a Trello card. |
Card Comment | Create a Comment | Adds a new comment to a specified Trello card. |
Card Comment | Get Card Comments | Retrieves all comments on a specified Trello card. |
Card Comment | Update a Comment | Updates the text content of an existing comment on a Trello card. |
Card Comment | Delete a Comment | Deletes a specified comment from a Trello card. |
Card Label | Add Label to Card | Adds a label to a specified Trello card. |
Card Label | Remove Label from Card | Removes a label from a specified Trello card. |
Checklist | Create Checklist on a Card | Creates a new checklist on a specified Trello card. |
Checklist | Get a Checklist | Retrieves detailed information for a checklist by its ID, including all checkitems. |
Checklist | Get Checklists on a Card | Retrieves all checklists on a specified Trello card. |
Checklist | Update a Checklist | Updates the name or position of a Trello checklist. |
Checklist | Delete a Checklist | Permanently deletes one or more Trello checklists by their ID(s). |
Checkitem | Create Checkitem on Checklist | Creates a new checkitem in a specified Trello checklist. |
Checkitem | Get Checkitems on a Checklist | Retrieves all checkitems in a specified Trello checklist. |
Checkitem | Get Completed CheckList Items | Retrieves all completed checkitems on a specified Trello card. |
Checkitem | Update Checkitem on Checklist on Card | Updates the name, state, or position of a specific checkitem in a checklist. |
Checkitem | Delete Checkitem from Checklist | Deletes one or more specified checkitems from a Trello checklist. |
Label | Create a Label | Creates a new label on a specified Trello board. |
Label | Get a Label | Retrieves detailed information for a label by its ID. |
Label | Get Labels on Board | Retrieves all labels on a specified Trello board. |
Label | Update a Label | Updates the name or color of a Trello label. |
Label | Delete a Label | Permanently deletes a Trello label by its ID. |
Search | Search Members | Searches for members by name or username, optionally limited to a specific board or organization. |
Search | Search Trello | Searches for boards, cards, members, and organizations in Trello based on a query string. |
Operation Details
Add Board Member
Adds a member to a specified Trello board and sets their member type (admin, normal, or observer).
Input Parameters:
- BoardId: The unique identifier of the Trello board to add the member to.
- MemberId: The identifier of the member, which can be a username, email address, or member ID.
Options:
- MemberType: The member's type on the board (admin, normal, observer). Defaults to normal.
Output:
- MemberAdded (bool): Indicates if the member was successfully added to the board.
- MemberData (object): Contains information about the added member, including ID, full name, username, type, avatar details, and membership status.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request/Member already exists), 404 (Board or Member not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Add Label to Card
Adds a label to a specified Trello card by providing the card ID and label ID.
Input Parameters:
- CardId: The ID of the Trello card to add the label to.
- LabelId: The ID of the label to add to the card.
Output:
- LabelAdded (bool): Indicates if the label was successfully added to the card.
- CardLabelIDs (array): A list of all label IDs on the card.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request/Label already on card), 404 (Card or Label not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Create Card Attachment
Creates a new URL attachment for a Trello card, allowing for a specified name, URL, optional MIME type, and cover settings.
Input Parameters:
- CardId: The ID of the card to which the attachment will be added.
- AttachmentName: The name/title of the attachment.
- AttachmentUrl: The URL of the attachment resource.
Options:
- MimeType: The MIME type of the attachment.
- SetCover: Whether to set this attachment as the card cover.
Output:
- AttachmentCreated (bool): Indicates if the attachment was successfully created.
- AttachmentData (object): An object containing the full attachment data, including ID, name, URL, MIME type, size, creation date, and other properties.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request), 404 (Card not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Create Checkitem on Checklist
Creates a new checkitem on a specified Trello checklist with optional parameters for position, state, due date, reminder, and assigned member.
Input Parameters:
- ChecklistId: The ID of the Trello checklist where the checkitem will be created.
- CheckitemName: The name/title of the checkitem to be created.
Options:
- Position: The position of the checkitem in the checklist. Can be 'top', 'bottom', or a decimal number.
- Checked: The initial state of the checkitem. Accepts 'true' or 'false'.
- DueDate: The due date for the checkitem in ISO 8601 format.
- DueReminder: Reminder time in minutes before the due date. Must be a number.
- MemberId: The ID of the member to assign the checkitem to.
Output:
- CheckitemInfo (object): Contains detailed checkitem information, including ID, name, state, position, due date, reminder, assigned member, and parent checklist.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request), 404 (Checklist not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Create Checklist on a Card
Creates a new checklist on a specified Trello card with a defined name and optional position.
Input Parameters:
- CardId: The ID of the Trello card on which the checklist will be created.
- ChecklistName: The name of the checklist to be created.
Options:
- Pos: The position of the checklist. Valid values are 'top', 'bottom', or a positive number.
Output:
- ChecklistInfo (object): An object containing detailed checklist information, including ID, name, card ID, board ID, position, and check items.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request), 404 (Card not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Create a Board
Creates a new Trello board with a specified name and optional settings for description, organization, default labels, and default lists.
Input Parameters:
- BoardName: The name of the board to be created.
Options:
- BoardDesc: The description of the board.
- IdOrganization: The ID of the organization to associate with the board.
- DefaultLabels: Whether to create default labels for the board.
- DefaultLists: Whether to create default lists for the board.
Output:
- BoardCreated (bool): Indicates if the board was successfully created.
- BoardData (object): Contains the full board data, including ID, name, description, URL, preferences, and other board properties.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request), 404 (Organization not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Create a Card
Creates a new card in a specified Trello list with a customizable name, description, position, due date, members, and labels.
Input Parameters:
- Name: The name of the card to be created.
- IdList: The ID of the list where the card will be created.
Options:
- Desc: The description of the card.
- Pos: The position of the card in the list ('top', 'bottom', or a numeric value).
- Due: The due date for the card in ISO 8601 format.
- IdMembers: A comma-separated list of member IDs to assign to the card.
- IdLabels: A comma-separated list of label IDs to assign to the card.
- Start: The start date for the card in ISO 8601 format.
Output:
- CardInfo (object): An object containing detailed information about the newly created card, including ID, name, description, status, board/list IDs, labels, members, due date, URL, and position.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request), 404 (List not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Create a Comment
Creates a new comment on a specified Trello card with the provided card ID and comment text.
Input Parameters:
- CardId: The ID of the Trello card to add the comment to.
- CommentText: The content of the comment to be added to the card.
Output:
- CommentInfo (object): Contains detailed information about the comment, including comment ID, creator details, comment text, creation date, and associated card information.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request), 404 (Card not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Create a Label
Creates a new label on a specified Trello board with a defined name and optional color.
Input Parameters:
- BoardId: The ID of the board on which the label will be created.
- Name: The name of the label to be created.
Options:
- Color: The color of the label. Valid colors include: yellow, purple, blue, red, green, orange, black, sky, pink, lime, null.
Output:
- LabelInfo (object): Contains detailed information about the label, including ID, name, color, board ID, and usage count.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request), 404 (Board not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Delete Attachment
Deletes a specified attachment from a Trello card by providing the card and attachment IDs. This action permanently removes the attachment.
Input Parameters:
- CardId: The ID of the Trello card containing the attachment.
- AttachmentId: The ID of the attachment to be deleted.
Output:
- Deleted (bool): Indicates if the attachment was successfully deleted.
- AttachmentId (string): The ID of the deleted attachment.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Card or Attachment not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Delete Board
Permanently deletes a Trello board by its ID. This action is irreversible and will remove all associated lists, cards, and data.
Input Parameters:
- BoardId: The ID of the Trello board to be deleted.
Output:
- Deleted (bool): Indicates if the board was successfully deleted.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Board not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Delete Card
Deletes one or more Trello cards specified by their card IDs. This action is irreversible.
Input Parameters:
- CardId: A single Trello card ID or a comma-separated list of multiple card IDs to be deleted.
Output:
- AllDeleted (bool): Indicates if all specified cards were successfully deleted.
- FailedItems (object-array): A list of items that failed to delete, each containing: CardId, StatusCode, and ErrorMessage.
- StatusCode (number): Overall operation status code: 200 (All successful), 207 (Partial success), 500 (All failed).
- ErrorMessage (string): An overall error message if parameter validation fails; otherwise, an empty string.
Delete Checkitem from Checklist
Deletes one or more checkitems from a Trello checklist using the checklist ID and checkitem IDs, supporting a comma-separated list of IDs.
Input Parameters:
- ChecklistId: The ID of the Trello checklist containing the checkitem(s) to be deleted.
- CheckitemId: The ID of the checkitem to be deleted. Can be a single ID or a comma-separated list of multiple IDs.
Output:
- AllDeleted (bool): Indicates if all specified checkitems were successfully deleted.
- FailedItems (object-array): A list of items that failed to delete, with fields including: CheckitemId, StatusCode, ErrorMessage.
- StatusCode (number): Overall operation status code: 200 (All successful), 207 (Partial success), 500 (All failed).
- ErrorMessage (string): An overall error message if parameter validation fails; otherwise, an empty string.
Delete a Checklist
Deletes one or more Trello checklists specified by their checklist IDs. This action is irreversible.
Input Parameters:
- ChecklistId: A single Trello checklist ID or a comma-separated list of multiple checklist IDs to be deleted.
Output:
- AllDeleted (bool): Indicates if all specified checklists were successfully deleted.
- FailedItems (array): A list of items that failed to delete, with fields including: ChecklistId, StatusCode, ErrorMessage.
- StatusCode (number): Overall operation status code: 200 (All successful), 207 (Partial success), 500 (All failed).
- ErrorMessage (string): An overall error message if parameter validation fails; otherwise, an empty string.
Delete a Comment
Deletes a specified comment from a Trello card using the comment ID (i.e., action ID).
Input Parameters:
- CommentId: The unique identifier (action ID) of the comment to be deleted.
Output:
- Deleted (bool): Indicates if the comment was successfully deleted.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Comment not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Delete a Label
Deletes a specified Trello label by its label ID. This action is irreversible.
Input Parameters:
- LabelId: The ID of the Trello label to be deleted.
Output:
- Deleted (bool): Indicates if the label was successfully deleted.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Label not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get All Lists
Retrieves all lists on a specified Trello board by its board ID.
Input Parameters:
- BoardId: The ID of the Trello board from which to retrieve the lists.
Output:
- Lists (object-array): A list of list objects with fields including: id, name, closed, idBoard, pos, subscribed, softLimit, limits.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Board not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get Board Data
Retrieves comprehensive data for a Trello board by its ID, including all lists, cards, members, labels, activity, and board settings.
Input Parameters:
- BoardId: The ID of the Trello board from which to retrieve data.
Output:
- BoardData (object): An object containing comprehensive board data, including ID, name, description, lists, cards, members, labels, activity, and all board settings.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Board not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get Board Members
Retrieves all members of a specified Trello board by its ID, including comprehensive information such as user details, avatars, preferences, and permissions.
Input Parameters:
- BoardId: The ID of the Trello board from which to retrieve members.
Output:
- MembersData (object-array): An array of all board members with comprehensive information, such as ID, full name, username, avatar, bio, status, permissions, and preferences.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Board not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get Card Attachments
Retrieves all attachments for a specified Trello card by its ID, including details such as file size, type, upload date, and download URL.
Input Parameters:
- CardId: The ID of the Trello card from which to retrieve attachments.
Output:
- Attachments (object-array): A list of attachment objects with details including ID, size, upload date, MIME type, name, and download URL.
- AttachmentCount (number): The total number of attachments found for the card.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Card not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get Card Comments
Retrieves all comments for a specified Trello card by its ID, including comment content, creation date, and creator information.
Input Parameters:
- CardId: The ID of the Trello card from which to retrieve comments.
Options:
- Page: The page number for pagination (>= 1, where 1 is the first page). If not specified, the API default (first page) is used.
Output:
- Comments (object-array): An array of comment objects, each containing ID, creator information, comment text, creation date, and card details.
- CommentCount (number): The total number of comments returned.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Card not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get Checkitems on a Checklist
Retrieves all checkitems from a specified Trello checklist by its ID, including their state, due date, and assigned member.
Input Parameters:
- ChecklistId: The ID of the Trello checklist from which to retrieve checkitems.
Output:
- CheckItems (object-array): A list containing all checkitems from the checklist, with fields including: id, name, state, pos, due, dueReminder, idMember, idChecklist.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Checklist not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get Checklists on a Card
Retrieves all checklists and their items from a specified Trello card by its ID.
Input Parameters:
- CardId: The ID of the Trello card from which to retrieve checklists.
Output:
- Checklists (object-array): An array of checklist objects, each including ID, name, board/card ID, position, and an array of checkitems with their details.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Card not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get Completed CheckList Items
Retrieves all completed checkitems from checklists on a specified Trello card, providing details on finished tasks.
Input Parameters:
- CardId: The ID of the Trello card from which to retrieve completed checkitems.
Output:
- CompletedCheckItems (object-array): An array of completed checkitems with detailed information such as ID, name, state, position, checklist info, and member assignment.
- TotalCompleted (number): The total number of completed checkitems found on the card.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Card not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get Labels on Board
Retrieves all labels on a specified Trello board by its board ID.
Input Parameters:
- BoardId: The ID of the Trello board from which to retrieve labels.
Output:
- Labels (object-array): An array of label objects with fields including: id, name, color, idBoard, and uses.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Board not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get List Cards
Gets all cards from a specified Trello list by its ID, including detailed information for each card such as members, labels, due dates, and badges.
Input Parameters:
- ListId: The ID of the Trello list from which to retrieve cards.
Output:
- Cards (object-array): An array containing all cards in the list with detailed information, including ID, name, description, members, labels, badges, and other metadata.
- TotalCards (number): The total number of cards found in the list.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (List not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get List Data
Gets detailed data for a Trello list by its ID, including all cards within the list and associated board information.
Input Parameters:
- ListId: The ID of the Trello list from which to retrieve data.
Output:
- ListData (object): A dictionary containing comprehensive list data, including ID, name, position, cards, and associated board information.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (List not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get a Card
Retrieves detailed information for a specified Trello card by its card ID.
Input Parameters:
- CardId: The ID of the Trello card to be retrieved.
Output:
- CardInfo (object): An object containing detailed card information, including ID, name, description, status, board/list IDs, labels, members, due date, and URL.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Card not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get a Checklist
Retrieves detailed information for a specified Trello checklist by its ID, including all checkitems and their states.
Input Parameters:
- ChecklistId: The ID of the Trello checklist to be retrieved.
Output:
- ChecklistInfo (object): An object containing detailed checklist information, including ID, name, board/card ID, position, and all checkitems with their states and details.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Checklist not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Get a Label
Retrieves detailed information for a specified Trello label by its label ID.
Input Parameters:
- LabelId: The ID of the Trello label to be retrieved.
Output:
- LabelInfo (object): A dictionary containing detailed label information, including ID, name, color, board ID, and usage count.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Label not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Invite Member To Join a Board
Invites a member to a Trello board via their email address and specifies their permissions (normal, admin, or observer).
Input Parameters:
- BoardId: The ID of the board to invite the member to.
- Email: The email address of the member to be invited.
Options:
- Type: The member permission type: normal, admin, or observer.
- FullName: The full name of the member to be invited.
Output:
- MemberInvited (bool): Indicates if the member was successfully invited to the board.
- InvitationData (object): An object containing invitation details, including member ID, email, permission type, confirmation status, and board information.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Board not found), 409 (Member already exists).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Archive or Unarchive a List
Archives or unarchives a Trello list by updating its closed status, allowing users to hide/show lists on a board without permanent deletion.
Input Parameters:
- ListId: The ID of the Trello list to be archived or unarchived.
Options:
- Archive: Archive operation flag, "true" to archive the list, "false" to unarchive it.
Output:
- ListInfo (object): Contains the updated list information, including ID, name, closed status, board ID, position, subscribed status, and other list properties.
- Archived (bool): Indicates if the list is currently archived (closed).
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (List not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Create a List
Creates a new list on a specified Trello board with a defined name and optional position, allowing users to organize cards on the board.
Input Parameters:
- BoardId: The ID of the Trello board where the list will be created.
- ListName: The name of the new list to be created.
Options:
- Position: The position of the list on the board. Can be 'top', 'bottom', or a numeric value.
Output:
- ListInfo (object): Contains information about the newly created list, including ID, name, board ID, position, subscribed status, and limits.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request), 404 (Board not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Update a List
Updates the properties of a Trello list, including its name, archived status, position, and subscription settings. Allows for modification of a list's metadata and configuration options within a board.
Input Parameters:
- ListId: The ID of the Trello list to be updated.
Options:
- Name: The new name of the list.
- Closed: Whether to archive the list: 'true' or 'false'.
- Position: The position of the list: 'top', 'bottom', or a numeric value.
- Subscribed: Whether to subscribe to the list: 'true' or 'false'.
Output:
- ListData (object): An object containing the updated list information, including ID, name, board ID, position, subscribed status, and limits.
- Updated (bool): Indicates if the list was successfully updated.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request), 404 (List not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Remove Board Member
Removes a specified member from a Trello board by their member ID or username. This action requires appropriate permissions to manage board members.
Input Parameters:
- BoardId: The ID of the Trello board from which to remove the member.
- MemberId: The ID or username of the member to be removed from the board.
Output:
- MemberRemoved (bool): Indicates if the member was successfully removed from the board.
- RemovedMemberInfo (object): An object containing details of the removed member, including ID, username, full name, avatar hash, avatar URL, initials, member type, and board ID.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Not Found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Remove Label from Card
Removes a label from a specified Trello card by providing the card and label IDs.
Input Parameters:
- CardId: The ID of the Trello card from which to remove the label.
- LabelId: The ID of the label to be removed from the card.
Output:
- LabelRemoved (bool): Indicates if the label was successfully removed from the card.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Card or Label not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Search Members
Retrieves all members of a specified Trello board, including comprehensive information such as user details, avatars, preferences, and permissions.
Input Parameters:
- Query: A search term to find members by name or username.
Options:
- Limit: The maximum number of results to return.
- IdBoard: The ID of a board to search for members within.
- IdOrganization: The ID of an organization to search for members within.
- OnlyOrgMembers: Whether to search for organization members only.
Output:
- MembersData (object-array): An array of member objects. Each member includes ID, personal information, avatar details, board, and organization associations.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Search Trello
Searches for boards, lists, cards, members, and organizations in Trello based on a query string, with optional filtering parameters.
Input Parameters:
- Query: A search query that supports Trello's advanced syntax (e.g., label:bug @me due:week).
Options:
- ModelTypes: The types of objects to search for (all, boards, cards, members, organizations).
- IdBoards: A comma-separated list of board IDs to limit the search scope.
- CardLimit: The maximum number of cards to return (1-1000).
- BoardLimit: The maximum number of boards to return (1-1000).
Output:
- SearchResults (object): A dictionary containing the search results, with arrays of matching objects (cards, boards, members, organizations) and their properties.
- StatusCode (number): The operation status code. E.g., 200 (Success), 400 (Bad Request).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Update Checkitem on Checklist on Card
Updates a checkitem on a checklist within a Trello card by modifying its name, position, or completion state.
Input Parameters:
- CardId: The ID of the Trello card containing the checkitem to be updated.
- CheckitemId: The ID of the checkitem to be updated.
Options:
- CheckitemName: The new name of the checkitem. Leave blank to keep unchanged.
- Position: The new position of the checkitem in the checklist. Can be 'top', 'bottom', or a decimal number. Leave blank to keep unchanged.
- State: The new completion state of the checkitem. Accepts 'complete' or 'incomplete'. Leave blank to keep unchanged.
- Due: The due date for the checkitem in ISO 8601 format. Leave blank to keep unchanged.
- DueReminder: The due date reminder in minutes. Leave blank to keep unchanged.
- IdMember: The ID of the member to assign the checkitem to. Leave blank to keep unchanged.
Output:
- CheckitemInfo (object): A dictionary containing the updated checkitem information, including ID, name, state, position, due date, reminder, assigned member, and parent checklist.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Card or Checkitem not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Update a Board
Updates the properties of a Trello board, including its name, description, visibility settings, permissions, and preferences. Allows for modification of a board's metadata and configuration options.
Input Parameters:
- BoardId: The ID of the Trello board to be updated.
Options:
- Name: The new name of the board.
- Description: The new description of the board.
- Closed: Whether to close the board: 'true' or 'false'.
- PermissionLevel: The board permission level: 'private', 'org', or 'public'.
- SelfJoin: Whether members can join themselves: 'true' or 'false'.
- CardCovers: Whether to show card covers: 'true' or 'false'.
- HideVotes: Whether to hide votes: 'true' or 'false'.
- Voting: The voting permission level: 'disabled', 'members', 'observers', 'org', 'public'.
- Comments: The commenting permission level: 'disabled', 'members', 'observers', 'org', 'public'.
- Background: The board background color or background ID.
- CardAging: The card aging style: 'pirate' or 'regular'.
- CalendarFeedEnabled: Whether to enable the calendar feed: 'true' or 'false'.
Output:
- BoardData (object): An object containing the updated board data with all properties and preferences.
- Updated (bool): Indicates if the board was successfully updated.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Not Found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Update a Card
Updates specified information for a Trello card, such as its name, description, status, list position, due date, and completion status.
Input Parameters:
- CardId: The ID of the Trello card to be updated.
Options:
- Name: The new name of the card.
- Description: The new description of the card.
- Closed: Whether to close the card, value is true or false.
- IdList: The ID of the list to move the card to.
- Due: The due date, in ISO 8601 format.
- DueComplete: Whether the card is complete, value is true or false.
- Start: The start date, in ISO 8601 format.
Output:
- Updated (bool): Indicates if the card was successfully updated.
- CardInfo (object): A dictionary containing the updated card information, including ID, name, description, status, board/list ID, labels, members, due date, and URL.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Card not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Update a Checklist
Updates the name and/or position of a Trello checklist. At least one update parameter (name or pos) must be provided.
Input Parameters:
- ChecklistId: The ID of the Trello checklist to be updated.
Options:
- Name: The new name of the checklist.
- Pos: The new position of the checklist. Can be a numeric string or 'top'/'bottom'.
Output:
- ChecklistInfo (object): An object containing the updated checklist information, including ID, name, board/card ID, position, and all checkitems with their states and details.
- Updated (bool): Indicates if the checklist was successfully updated.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Checklist not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Update a Comment
Updates the text content of an existing comment on a Trello card.
Input Parameters:
- CommentId: The ID of the comment to be updated.
- CommentText: The new text content for the comment.
Output:
- CommentInfo (object): An object containing the updated comment information, including ID, creator details, comment data with text, action type, date, member creator info, and associated card info.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Comment not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
Update a Label
Updates the name and/or color of a Trello label by its ID. At least one of the parameters, name or color, must be provided.
Input Parameters:
- LabelId: The ID of the Trello label to be updated.
Options:
- Name: The new name of the label.
- Color: The new color of the label. Valid colors: yellow, purple, blue, red, green, orange, black, sky, pink, lime.
Output:
- LabelInfo (object): An object containing the updated label information, including ID, name, color, board ID, and usage count.
- Updated (bool): Indicates if the label was successfully updated.
- StatusCode (number): The operation status code. E.g., 200 (Success), 404 (Label not found).
- ErrorMessage (string): A description of the error if the operation failed; an empty string on success.
5. Example Usage
This section will guide you through creating a simple workflow to create a new card in a specific list on your Trello board.
Workflow Overview
Start -> Trello: Create a Card -> Answer
Step-by-Step Guide
- Add Tool Node:
- In the workflow canvas, click the "+" sign to add a new node.
- In the pop-up panel, select the "Tools" tab.
- In the tool list, find and select Trello.
- In the list of supported operations for Trello, click to select Create a Card, which will add a corresponding node to the canvas.
- Configure Node:
- Click the newly added Create a Card node to open its configuration panel on the right.
- Credential Configuration: At the top of the panel, find the credential field. Click the dropdown menu and select your pre-configured Trello credential.
- Parameter Entry: Fill in the input parameters for the operation in detail.
- Name: Enter a title for your new card, for example, "Complete project documentation".
- IdList: Enter the ID of the list where you want to create the card. You can find this ID in the URL of a Trello list. For example, in the URL https://trello.com/c/cardId/listId-card-name, listId is the value you need.
- Run and Validate:
- When all required parameters are correctly filled in, the error prompt in the top right corner of the workflow canvas will disappear.
- Click the "Run" button in the top right corner of the canvas to execute the workflow.
- After successful execution, you can click the log icon in the top right corner to view the node's detailed input and output. You should also be able to see the newly created card under the specified list in Trello.
Final Workflow Display
Upon completing these steps, your entire workflow will be configured. Clicking "Run" will successfully create a new Trello card in your specified list.
6. FAQs
Q: Why am I receiving a 401 Unauthorized or 403 Forbidden error?
A: This is usually related to your credential configuration. Please check the following:
- API Key and Token: Ensure that the Trello credentials (API Key and Token) you configured in GoInsight are correct and still valid.
- Permission Scope: Check if the API token you generated has the necessary permissions to perform the required actions (e.g., read and write permissions). You may need to generate a new token in Trello with broader permissions.
- Board Permissions: Make sure your Trello account is a member of the target board and has permission to create or modify content.
Q: How do I get the ID for a Board, List, or Card?
A: You can easily find these IDs in the Trello URL.
- Board ID: Open your board, and the URL format is typically https://trello.com/b/[BoardId]/board-name.
- List and Card ID: When you click on a card, the URL changes to https://trello.com/c/[CardId]/[ListId]-card-name. [CardId] is the card ID, and the following [ListId] is the list ID.
Q: Can I create multiple cards at once?
A: The Create a Card operation itself can only create one card at a time. However, you can design a loop logic in a GoInsight workflow. For example, you can get a list of items from a data source (like an HTTP request or a database query) and then use a loop node to call the Create a Card node in each iteration to create a Trello card for each item in the list.
7. Official Documentation
For a more in-depth understanding of all the features and parameters of the Trello API, please refer to the official documentation:
Leave a Reply.