Trello

Updates the comment preferences for a specific trello board, controlling who can add comments to cards. this endpoint allows you to change the comment permissions, ranging from completely disabling comments to allowing public access. use this when you need to adjust the collaboration settings of a board, either to restrict or expand commenting abilities. the changes apply immediately to all current and future cards on the board. note that this endpoint only modifies comment preferences and does not affect other board settings or permissions.

Action Parameters

Action Response

Updates the query of a specific saved search for a trello member. this endpoint allows you to modify the search terms of an existing saved search without changing other attributes of the saved search. it’s useful when you need to refine or adjust a frequently used search query. the endpoint requires the member’s id and the saved search id as path parameters, and accepts a new query value in the request body. use this when a user wants to update their saved search criteria without creating a new saved search or altering other saved search properties.

Action Parameters

Action Response

This endpoint allows you to update the color of a specific trello label. it is used when you need to change the visual appearance of a label on trello cards and boards. the endpoint takes the label id as a path parameter and accepts a json payload with the new color value. you can use this to categorize or prioritize cards more effectively by adjusting their label colors. it’s important to note that setting the color to null will remove the color from the label, essentially making it a text-only label. this endpoint should be used for single label color updates; for bulk updates, consider using batch api calls if available.

Action Parameters

Action Response

Retrieves the custom board backgrounds associated with a specific trello member. this endpoint allows you to fetch all the personalized background images that a member has uploaded or selected for use on their trello boards. it’s useful for applications that need to display or manage a user’s board customization options. the endpoint returns an array of board background objects, likely including details such as image urls, colors, and other relevant attributes. use this when you need to access or display a member’s available board backgrounds, for example, when allowing a user to choose a background for a new board or when syncing customization settings across devices.

Action Parameters

Action Response

Retrieves the current user’s preferences for a specific trello board. this endpoint allows users to fetch their personalized settings and configurations for a particular board, such as notification preferences, background preferences, or custom field settings. it’s useful when you need to display or sync a user’s board-specific preferences in your application. the endpoint returns only the preferences for the authenticated user and the specified board, not for other members or boards. use this when you want to tailor the user experience based on their individual board settings or when implementing features that require knowledge of user-specific board configurations.

Action Parameters

Action Response

Retrieves detailed information about a specific action in trello. this endpoint allows you to fetch the complete data associated with a single action, such as creating a card, moving a list, or adding a comment. it’s useful when you need to access the full context and details of a particular activity that occurred on a trello board. the endpoint should be used when you want to investigate or audit specific changes, or when building activity logs and timelines. note that this endpoint only provides information about a single action; for retrieving multiple actions or a feed of activities, a different endpoint would be more appropriate.(DEPRECATED use get_actions_by_id_action)

Action Parameters

Action Response

Updates the “show sidebar board actions” preference for a specific trello board. this endpoint allows users to customize their board view by choosing whether to display or hide board actions in the sidebar. it’s particularly useful for managing the visual clutter on a board, especially for boards with high activity. the preference is user-specific, meaning each board member can have their own setting without affecting others. use this endpoint when a user wants to change their personal view of the board’s sidebar actions.

Action Parameters

Action Response

Retrieves all cards within a specified trello list. this endpoint allows users to fetch detailed information about cards in a particular list, providing a comprehensive view of tasks or items within that list. it’s particularly useful for applications that need to synchronize trello data, build custom views of trello boards, or perform bulk operations on cards within a specific list. the endpoint returns an array of card objects, each containing details such as the card’s name, description, due date, and any custom fields. use this endpoint when you need to get an up-to-date snapshot of all cards in a list, but note that it doesn’t provide real-time updates or webhook functionality for card changes.(DEPRECATED use get_lists_cards_by_id_list)

Action Parameters

Action Response

Retrieves a list of cards from a specified trello board, with optional filtering capabilities. this endpoint is essential for accessing and managing task information within a trello project. it allows users to fetch cards based on various criteria, enabling efficient organization and analysis of project tasks. the endpoint is particularly useful for integrations that need to sync trello data with other project management tools or for creating custom reports and dashboards. note that while this endpoint provides comprehensive card data, it does not modify any information on the board.(DEPRECATED use get_boards_cards_by_id_board_by_filter)

Action Parameters

Action Response

Updates the position of a specific check item within a checklist on a trello card. this endpoint allows you to reorder check items by moving them to the top, bottom, or a specific position within the checklist. it’s useful for prioritizing tasks or reorganizing workflow steps. the update is applied immediately, affecting the order of items as seen by all users with access to the card. use this when you need to change the order of tasks in a checklist without modifying their content or completion status.

Action Parameters

Action Response

Adds a board star for a specific trello member, allowing them to mark a board as a favorite or frequently accessed. this endpoint is used to create a new board star, specifying which board to star and where to position it in the member’s list of starred boards. it’s particularly useful for organizing and prioritizing boards for quick access. the endpoint should be used when a user wants to star a new board or adjust the position of an existing starred board. it does not provide functionality for removing board stars or retrieving a list of starred boards.

Action Parameters

Action Response

This endpoint removes a specific label from a trello card. it’s used to update the organization or categorization of a card by removing an associated label. the operation is performed by sending a delete request to the specified url with the card id and label id as path parameters. this action is irreversible and should be used when you want to disassociate a label from a card, such as when a task changes category or a tag is no longer relevant. it’s important to note that this endpoint only removes the association between the card and the label; it does not delete the label itself from the trello board.

Action Parameters

Action Response

Updates the list assignment of a specific trello card. this endpoint allows you to move a card from one list to another within the same board. it’s particularly useful for updating the status or progress of a task represented by the card. the operation is idempotent, meaning that moving a card to its current list will not cause any changes. this endpoint should be used when you need to programmatically update the position of a card in your trello workflow. it’s important to note that this operation only changes the list assignment and does not modify any other attributes of the card.

Action Parameters

Action Response

This endpoint marks all notifications associated with a specific trello card as read. it’s useful for managing notification status programmatically, especially in scenarios where bulk actions on card notifications are needed. the endpoint should be used when you want to clear the unread status of all notifications linked to a particular card, such as after a user has viewed or processed the card’s updates. this action is irreversible, so use it judiciously. note that this endpoint only affects the read status of notifications and does not delete or modify the notifications themselves.

Action Parameters

Action Response

Retrieves detailed information about a specific trello organization. this endpoint allows you to fetch comprehensive data about an organization, including its name, description, members, boards, and other relevant attributes. use this endpoint when you need to access or display organization-level information within your application or workflow. it’s particularly useful for scenarios where you need to verify organization details, list associated boards, or manage organization-wide settings. note that this endpoint only provides read access to the organization data and does not allow modifications.

Action Parameters

Action Response

This endpoint updates the invite restriction preferences for a trello organization. it allows administrators to control who can invite new members to the organization by specifying an email address, domain, or special value. use this endpoint when you need to change the organization’s policy on member invitations, such as restricting invites to specific email domains or individuals. this tool is particularly useful for maintaining security and managing growth in large or sensitive trello organizations. note that this endpoint only updates the preference and does not directly add or remove members.

Action Parameters

Action Response

Updates the attributes of a specific member on a trello board. this endpoint allows you to modify a member’s email address, full name, and role (type) associated with a particular board. use this when you need to change a member’s information or adjust their permissions on the board. it’s particularly useful for administrative tasks such as updating contact information or changing a member’s role. note that this endpoint only affects the member’s attributes for the specified board and does not modify their global trello account settings. be cautious when changing member roles, as it directly impacts their access and capabilities on the board.

Action Parameters

Action Response

Retrieves a specific field of the list associated with a given trello action. this endpoint is useful when you need to access particular information about the list where an action occurred, without fetching all list details. it can be used to confirm the list’s name, check if it’s closed, or get its board id after an action has been performed. this endpoint is particularly helpful for tracking changes or verifying the current state of a list following a specific action. note that it only returns a single field value, not the entire list object, making it efficient for targeted data retrieval.

Action Parameters

Action Response

Permanently deletes a trello organization and all its associated data. this endpoint should be used when an organization is no longer needed and all its boards, lists, cards, and member associations should be removed. once an organization is deleted, the action cannot be undone, and all data will be lost. this operation requires appropriate permissions, typically limited to organization administrators. use this endpoint with caution as it will remove all resources linked to the organization, including shared boards and team data.

Action Parameters

Action Response

Retrieves a list of organizations that a specific trello member has been invited to join but has not yet accepted or declined. this endpoint is useful for tracking pending organization invitations for a given user. it can be used to display a list of outstanding invitations, allowing the member to review and take action on them. the endpoint does not provide information about organizations the member has already joined or invitations that have been declined. use this endpoint when you need to fetch all pending organization invitations for a particular trello member, such as for notification purposes or to prompt the user to act on outstanding invitations.

Action Parameters

Action Response

Retrieves all boards associated with a specific trello member. this endpoint allows you to fetch a comprehensive list of boards that the member has access to, including boards they own, are members of, or have been invited to. it’s particularly useful for applications that need to display or work with a user’s trello boards, such as for data synchronization, board management, or creating board-related features. the response typically includes details like board ids, names, and other metadata. use this endpoint when you need to get an overview of a member’s trello workspace or when implementing board selection features in your application. note that it only provides board-level information and does not include details about lists or cards within the boards.(DEPRECATED use get_members_boards_by_id_member)

Action Parameters

Action Response

This endpoint allows you to add a custom board background for a specific trello member. it enables personalization of a member’s trello boards by uploading and configuring a unique background image. use this endpoint when you want to enhance the visual appeal of a member’s boards or create a distinct look for different projects or teams. the custom background can be adjusted for brightness and tiling to ensure optimal visibility of board content. note that this endpoint is member-specific and should be used judiciously to maintain a balance between personalization and consistent team experience.

Action Parameters

Action Response

Retrieves all checkitems associated with a specific checklist in trello. this endpoint allows you to fetch the complete list of items within a given checklist, providing details such as the item’s name, state (complete or incomplete), and position within the checklist. use this endpoint when you need to review or process all tasks within a particular checklist, such as for progress tracking or task management. it’s particularly useful for applications that need to sync or display trello checklist data. note that this endpoint only retrieves existing checkitems and does not create, update, or delete them.

Action Parameters

Action Response

Retrieves a filtered list of boards associated with a specific trello organization. this endpoint allows users to fetch boards based on various criteria such as membership, status, visibility, and more. it’s particularly useful for getting an overview of boards within an organizational context or for finding specific types of boards (e.g., public boards, starred boards). the endpoint supports customization through the filter parameter, enabling precise queries to match user requirements. note that the response will only include boards that the authenticated user has permission to view within the specified organization.

Action Parameters

Action Response

This endpoint allows dismissing a specific type of one-time message for a trello member. it’s used to mark certain notifications or alerts as acknowledged or no longer relevant for the user. this is particularly useful for managing user preferences and reducing notification clutter. the endpoint should be called when a member interacts with a one-time message, choosing to dismiss it. it helps in personalizing the user experience by remembering which introductory or special messages the user has already seen and acknowledged.

Action Parameters

Action Response

Creates a new card in a specified trello list with customizable attributes. this endpoint allows you to add a card to an existing list, optionally copying properties from another card, setting due dates, assigning members, adding labels, and more. use this when you need to programmatically create new tasks or items in your trello workflow. the endpoint is versatile, supporting simple card creation with just a name and list id, as well as complex scenarios involving multiple attributes and attachments. note that while many parameters are optional, at minimum, you must specify the ‘idlist’ where the card will be added.

Action Parameters

Action Response

Deletes a specific trello action identified by its unique id. this endpoint should be used when you need to permanently remove an action from a trello board’s history. it’s particularly useful for cleaning up unwanted or erroneous actions, such as accidental card creations or comments. once an action is deleted, it cannot be recovered, so use this endpoint with caution. note that not all actions may be deletable, and attempting to delete certain system-generated actions might result in an error.

Action Parameters

Action Response

Retrieves the member information associated with a specific trello notification. this endpoint allows you to get details about the user who is related to a particular notification, such as the member who created a card that triggered the notification. use this endpoint when you need to identify or gather information about the member involved in a specific trello notification event. it’s particularly useful for tracking user activities, auditing notification sources, or displaying member details alongside notification content in your application. note that this endpoint only provides member data directly linked to the specified notification and does not return the notification content itself or other board-wide member information.

Action Parameters

Action Response

Retrieves notifications for a specific trello member. this endpoint allows you to fetch all notifications associated with the given member, including alerts about new comments, card movements, mentions, and other board activities. use this endpoint when you need to display or process a member’s recent notifications, such as for creating a notification center or syncing member activities across platforms. the endpoint returns notifications in reverse chronological order, with the most recent notifications first. note that this endpoint may be subject to rate limiting and pagination for members with a large number of notifications.

Action Parameters

Action Response

Retrieves information about the list associated with a specific trello action. this endpoint is useful when you need to determine which list was affected by a particular action, such as moving a card or updating a list’s properties. it provides context for action events, helping to track changes across a trello board. use this endpoint when you want to get details about the list involved in a specific action, rather than querying all lists on a board. note that this endpoint focuses solely on the list associated with the action and does not provide information about the action itself or other related entities like cards or board details.(DEPRECATED use get_actions_list_by_id_action)

Action Parameters

Action Response

Adds a specified member to a trello card. this endpoint allows you to assign a team member or user to a specific card, which represents a task or project item. use this when you need to delegate responsibilities, track ownership of tasks, or involve specific team members in a card’s activities. the operation requires the unique identifiers of both the card and the member to be added. this functionality is essential for managing team assignments and task distribution within trello boards. note that this endpoint only adds one member at a time; for bulk assignments, multiple calls may be necessary.

Action Parameters

Action Response

This endpoint allows you to add a new label to a specific trello card. it provides options to set the label’s color, name, and value, enabling better organization and visual categorization of cards on a trello board. use this endpoint when you need to add or update labels on a card to reflect its status, priority, or any other classification. the endpoint is particularly useful for automating label management or implementing custom labeling logic in your trello workflows. note that while you can specify both ‘color’ and ‘value’ parameters, ‘value’ takes precedence if both are provided. also, be aware that creating too many unique labels might clutter your board, so use this feature judiciously.

Action Parameters

Action Response

Retrieves filtered notifications for a specific trello member. this endpoint allows users to fetch notifications based on a specified filter, enabling targeted information retrieval about updates, changes, or activities relevant to the member. it’s particularly useful for staying informed about specific aspects of trello boards, lists, or cards that the member is involved with. the endpoint should be used when needing to access a member’s notifications with custom filtering, but it won’t provide real-time updates or modify the notification status.

Action Parameters

Action Response

Updates a specific check item within a checklist on a trello card. this endpoint allows for modifying various attributes of a check item, including its name, position, completion state, and even moving it to a different checklist on the same card. it’s useful for task management and progress tracking within trello cards. the endpoint requires the ids of the card, current checklist, and check item to be updated, which should be provided in the url path. only the attributes that need to be changed should be included in the request body, allowing for partial updates.

Action Parameters

Action Response

Updates the attributes of a specific board star for a trello member. this endpoint allows you to modify which board is starred or adjust the position of the star in the member’s list of starred boards. use this when a user wants to change their board star preferences, such as re-ordering their starred boards or starring a different board in place of an existing star. the endpoint requires the member’s id and the specific board star id to be updated. you can change the associated board by providing a new board id and adjust the star’s position using the ‘pos’ parameter. this operation directly modifies the user’s board star settings, so use it judiciously based on user intent.

Action Parameters

Action Response

Retrieves a filtered list of boards associated with a specific trello member. this endpoint allows you to fetch boards based on various criteria such as their status (open, closed), visibility (public), organizational association, or member’s relationship to the board (starred, invited). it’s particularly useful for applications that need to display or manage a subset of a member’s boards, enabling more focused and efficient data retrieval. the endpoint requires the member’s unique identifier and a filter parameter to customize the query. it should be used when you need to access or display a specific category of boards for a given trello user, rather than fetching all boards indiscriminately.(DEPRECATED use get_members_boards_by_id_member_by_filter)

Action Parameters

Action Response

Retrieves all custom stickers associated with a specific trello member. this endpoint allows you to fetch the unique, personalized stickers that a member has created or uploaded for use on their trello cards. it’s particularly useful when you need to display or manage a member’s custom sticker collection. the endpoint returns a list of custom stickers, including their images and metadata. note that this only retrieves custom stickers, not the standard trello stickers available to all users. use this endpoint when you need to access a member’s personalized sticker set, such as for displaying in a sticker picker or for inventory management purposes.

Action Parameters

Action Response

Retrieves detailed information about the card associated with a specific trello action. this endpoint is useful when you need to access the current state or details of a card that was affected by a particular action, such as a card being moved, edited, or commented on. it provides a way to trace the impact of an action on a card and gather its up-to-date information. use this endpoint when you want to follow up on an action notification or need to sync card data after a known action has occurred. note that this endpoint only returns information about the card itself and not about the action that led to querying this card.

Action Parameters

Action Response

Updates the due date of a specific trello card. this endpoint allows you to set or modify the deadline for a task represented by a card. it’s useful for managing timelines and priorities within your trello boards. the endpoint accepts a new date value or null to remove the due date. use this when you need to adjust task deadlines or remove time constraints from a card. note that this operation only affects the due date and does not modify other card attributes.

Action Parameters

Action Response

Retrieves detailed information about a specific custom board background for a given trello member. this endpoint allows you to fetch the properties and metadata of a particular custom background that a member has associated with their account. it’s useful when you need to display or verify the details of a custom background, such as its dimensions, file type, or any custom attributes trello might associate with it. the endpoint should be used when you have both the member’s id and the specific board background id, typically in scenarios where you’re managing or displaying user-specific board customizations. note that this endpoint only provides information about the background and does not return the actual image file itself.

Action Parameters

Action Response

Retrieves a filtered list of members for a specific trello board. this endpoint allows you to fetch a subset of board members based on certain criteria, such as their role or status within the board. it’s particularly useful for managing large boards, performing targeted actions on specific groups of members, or auditing board membership. the endpoint requires the board’s unique identifier and a filter parameter to specify which members to return. it should be used when you need to analyze or manipulate board membership data programmatically. note that this endpoint only provides member information and does not allow for modifying member status or permissions directly.

Action Parameters

Action Response

Deletes a specific checklist from a trello card. this endpoint allows users to remove a checklist entirely from a card, which can be useful for cleaning up completed or unnecessary checklists. the operation is irreversible, so it should be used with caution. this endpoint is particularly helpful when managing card content and simplifying the card’s structure by removing outdated or completed checklists. it requires both the card’s id and the checklist’s id to ensure precise targeting of the checklist to be deleted.

Action Parameters

Action Response

Updates the closed status of a specified trello board. this endpoint allows you to either close an active board or reopen a closed board by setting the ‘value’ parameter to ‘true’ or ‘false’ respectively. use this when you need to archive a completed project or bring back a previously closed board for further use. it’s important to note that closing a board doesn’t delete it, but rather makes it inactive and inaccessible for normal operations. this action can be reversed by using the same endpoint to reopen the board.

Action Parameters

Action Response

Updates the name of a specific trello board. this endpoint allows you to change the title of an existing board, which is useful for renaming projects, updating team workspaces, or refining board organization. it should be used when you need to modify the name of a board without altering its content or structure. the endpoint requires the board’s unique identifier (idboard) in the url path and accepts a new name value in the request body. note that this operation only affects the board’s name and does not impact its members, lists, or cards.

Action Parameters

Action Response

Retrieves all cards associated with a specific trello board. this endpoint allows users to fetch a comprehensive list of cards, including their details such as names, descriptions, due dates, and other attributes, from a given board. it’s particularly useful for getting an overview of all tasks or items within a project or workflow. the endpoint should be used when you need to gather information about multiple cards at once, rather than querying individual cards separately. note that this endpoint may have limitations on the number of cards returned in a single request for boards with a large number of cards, and pagination might be necessary for complete retrieval.

Action Parameters

Action Response

Updates the organization of a specified trello board. this endpoint allows you to move a board from one organization to another by changing its organization id. use this when you need to reorganize your trello workspace structure or when a project needs to be transferred to a different team or department. the operation requires the id of the board to be updated and the id of the new organization. it’s important to note that this action may affect board visibility and access permissions, so ensure that the board members have appropriate access to the new organization before making the change. this endpoint doesn’t return the updated board details, so you may need to fetch the board information separately to confirm the change.

Action Parameters

Action Response

Removes a specific member’s vote from a trello card. this endpoint is used when you need to undo a member’s vote on a card, which can be useful for managing decision-making processes or cleaning up outdated votes. it should be called when a member wants to retract their vote or when an administrator needs to remove a vote on behalf of a member. the operation is irreversible, so it should be used with caution. this endpoint does not provide any information about the remaining votes on the card or confirm the previous existence of the vote; it simply attempts to remove the specified member’s vote from the specified card.

Action Parameters

Action Response

Updates the permission level preferences for a specified trello organization (workspace). this endpoint allows administrators to control the visibility and accessibility of the organization by setting it to either private or public. use this when you need to change the organization’s privacy settings, such as making it more restricted or opening it up for broader access. the change affects all boards and workspaces within the organization, so it should be used carefully. note that this endpoint only modifies the permission level and does not alter other organization settings or board-specific permissions.

Action Parameters

Action Response

Updates the attributes of a specific sticker on a trello card. this endpoint allows you to modify various properties of an existing sticker, including its image, position, rotation, and layer order. use this when you need to adjust the appearance or layout of stickers on a card, such as repositioning, changing the image, or altering the stacking order. the endpoint requires the unique identifiers for both the card and the sticker. it’s important to note that while some parameters are typed as strings, they may represent numeric values (e.g., for positioning or rotation). this endpoint is particularly useful for fine-tuning the visual organization of card information in trello boards.

Action Parameters

Action Response

Retrieves a list of members who have been invited to join a specific trello organization but have not yet accepted the invitation. this endpoint is useful for organization administrators to track pending invitations and manage membership. it provides information about invited users, which may include details such as their username, full name, and invitation status. use this endpoint when you need to review or audit the list of outstanding invitations for an organization. note that this endpoint only returns data about invited members; it does not include information about active members or provide functionality to send new invitations.

Action Parameters

Action Response

Retrieves a list of members associated with a specific trello board. this endpoint allows you to fetch all users who have access to the board, including their roles and permissions. use this when you need to get information about the team members working on a particular board, manage access, or sync member data with other systems. the endpoint returns member details such as usernames, full names, and member types, but does not provide in-depth information about their activities on the board.

Action Parameters

Action Response

This endpoint allows you to update the unread status of a specific trello notification. it’s used to programmatically mark a notification as read or unread, which can be helpful for managing notification states in integrations or automated workflows. the endpoint takes the notification’s unique identifier and a boolean value to set its unread status. this tool is particularly useful for keeping trello notifications in sync with external systems or for bulk management of notification states. note that this endpoint only updates the unread status and does not modify any other attributes of the notification.

Action Parameters

Action Response

This endpoint removes the invite restriction preferences for a specific trello organization. when invoked, it resets the organization’s settings related to who can invite new members, effectively removing any custom restrictions that were previously in place. this action allows for more open member invitation policies within the organization. use this endpoint when you want to lift invite restrictions and allow all members to invite new people to the organization. it’s particularly useful for organizations that previously had strict invite policies but now want to encourage growth and collaboration. note that this action may have security implications, as it potentially broadens who can add new members to the organization.

Action Parameters

Action Response

Deletes a specific webhook from the trello system using its unique identifier. this endpoint is used to permanently remove a webhook that is no longer needed or has become obsolete. once deleted, the webhook will stop receiving notifications about changes to the associated trello resources. this operation is irreversible, so it should be used with caution. it’s particularly useful for cleaning up webhooks that are no longer in use, reducing unnecessary api calls and maintaining a clean integration setup.

Action Parameters

Action Response

Updates the calendar feed enabled preference for a specific trello board. this endpoint allows you to enable or disable the calendar feed feature, which provides a calendar view of cards with due dates and allows for integration with external calendar applications. use this when you want to toggle the visibility of board tasks in calendar format or control the availability of the icalendar feed for the board. this operation is particularly useful for teams that rely on calendar views for project management or need to sync trello tasks with external calendar tools. note that enabling this feature may have privacy implications, as it potentially makes board data accessible through calendar feeds.

Action Parameters

Action Response

Updates the “show list guide” preference for a specific trello board. this endpoint allows users to toggle the visibility of the list guide feature, which provides guidance and tips for using lists on the board. use this when you want to enable or disable the list guide for a particular board, helping to customize the board’s appearance and user experience. the change applies immediately and affects all users who have access to the board. note that this preference is board-specific and does not affect other boards or global trello settings.

Action Parameters

Action Response

Adds a member’s vote to a specific trello card. this endpoint allows you to record a ‘yes’ vote from a particular member on a given card. it’s useful for tracking member opinions or decisions related to the card’s content or status. the endpoint should be used when you need to programmatically add a member’s approval or agreement to a card, which can be helpful in workflows that require voting or consensus. note that this endpoint only adds positive votes; there is no option to add a negative vote or remove a vote using this call. also, be aware that a member can only have one vote per card, so calling this endpoint multiple times for the same member on the same card will not result in multiple votes.

Action Parameters

Action Response

Retrieves detailed information about a specific sticker on a particular trello card. this endpoint allows you to fetch the properties of a single sticker, such as its image, position on the card, and any other metadata associated with it. it’s useful when you need to access or verify the details of a specific sticker, perhaps for display purposes or to confirm its current state. this tool should be used when precise information about an individual sticker is required, rather than for bulk retrieval of all stickers on a card. note that this endpoint does not modify the sticker; it only retrieves its current state.

Action Parameters

Action Response

Retrieves all lists associated with a specific trello board. this endpoint allows you to fetch the complete set of lists that exist on a given board, providing an overview of the board’s structure and organization. use this when you need to display or analyze the current layout of a board, such as when building a board overview or preparing for task management operations. the endpoint returns basic information about each list, typically including its id, name, and position on the board. note that this endpoint does not return the cards within the lists; to get that level of detail, you would need to make separate api calls for each list.(DEPRECATED use get_boards_lists_by_id_board)

Action Parameters

Action Response

This endpoint adds an attachment to a specific trello card. it allows users to upload files directly or attach links to external resources, enhancing the card’s information and context. use this when you need to include supporting documents, images, or relevant web links to a card. the attachment can be either a file upload or a url, providing flexibility in the types of resources that can be added. note that while the endpoint accepts various attachment types, there may be size limits or file type restrictions imposed by trello’s system.

Action Parameters

Action Response

Searches for trello members based on the provided query string. this endpoint allows you to find users by their name, username, or email address, making it useful for user discovery and member management within trello. the search is performed across all accessible trello members, with optional filters for specific boards or organizations. use this endpoint when you need to locate trello users, verify member existence, or gather member information for collaboration purposes. the search results are paginated and can be limited to control the response size.

Action Parameters

Action Response

Retrieves cards associated with a specific checklist in trello. this endpoint allows users to fetch cards that are linked to a particular checklist, providing a way to see all tasks or items related to a checklist across different cards or boards. the endpoint is useful for tracking progress on checklist items, identifying which cards are using a specific checklist, or gathering information for reporting purposes. it’s particularly helpful when managing complex projects with interrelated tasks spread across multiple cards. the endpoint supports filtering to customize the returned set of cards, allowing for more precise data retrieval based on the user’s needs.

Action Parameters

Action Response

Retrieves detailed information about a specific membership within a trello organization. this endpoint allows you to fetch the membership details of a particular user in a given organization, providing insights into their role, permissions, and other relevant information. it’s useful for auditing organization members, verifying a user’s status, or retrieving specific membership attributes. the endpoint requires both the organization id and the membership id to pinpoint the exact membership record. note that this endpoint only retrieves information and does not modify any data.

Action Parameters

Action Response

This endpoint retrieves a specific field of the organization associated with a given trello notification. it allows users to access detailed information about the organization context of a notification without fetching the entire organization object. this can be particularly useful when you need quick access to a single piece of organization data related to a notification, such as the organization’s name or description. the endpoint should be used when you have a notification id and need to extract a particular organization detail linked to that notification. it’s important to note that this endpoint will only return data for notifications that are associated with an organization; personal board notifications may not return any data.

Action Parameters

Action Response

Retrieves lists associated with a specific trello board. this endpoint allows users to fetch all lists or filter them based on their status (open, closed, or all). it’s particularly useful for getting an overview of a board’s structure, preparing for task management, or syncing board data with external systems. the endpoint supports filtering to efficiently retrieve only the required lists, which is especially beneficial for boards with numerous lists. however, it does not provide detailed information about the cards within each list; separate api calls would be needed for that level of detail.

Action Parameters

Action Response

Retrieves information about the member who created a specific trello notification. this endpoint is useful for obtaining details about the user responsible for triggering a particular notification, providing context to the notification’s origin. it should be used when you need to identify or get more information about the member behind a notification action. the endpoint focuses solely on the creator’s details and does not provide information about the notification content itself or other related data. keep in mind that accessing this information may be subject to permission settings and the user’s role within the trello board or organization.

Action Parameters

Action Response

Retrieves a specific field of a trello card. this endpoint allows you to fetch individual attributes of a card without retrieving the entire card object, which can be useful for targeted data retrieval and improved performance. it should be used when you need to access a particular piece of information about a card, such as its name, description, due date, or any other supported field. this tool is particularly helpful for checking specific card details or for integrations that need to monitor or sync certain card attributes. note that this endpoint will only return the value of the requested field; if you need multiple fields or the complete card data, you should use a different endpoint that returns the full card object.

Action Parameters

Action Response

Retrieves all boards associated with a specific trello organization. this endpoint allows users to fetch a comprehensive list of boards within a given workspace, providing an overview of all projects and tasks managed by the organization. it’s particularly useful for administrators or team leads who need to monitor or manage multiple boards across their organization. the endpoint returns basic information about each board, such as its name, url, and id, enabling further actions or queries on individual boards if needed. use this when you need a high-level view of an organization’s project structure or when preparing to perform bulk operations on multiple boards within the same workspace.

Action Parameters

Action Response

Adds a sticker to a specific trello card. this endpoint allows you to customize the appearance and position of a sticker on a card, enhancing visual organization and communication within your trello boards. use this when you want to highlight important information, categorize cards, or add visual cues to your trello workflow. the sticker’s image, position, rotation, and stack order can be specified for precise placement. note that this endpoint only adds a single sticker per request; multiple calls are required to add multiple stickers to the same card.

Action Parameters

Action Response

Retrieves a specific attachment from a trello card. this endpoint allows you to fetch detailed information about a single attachment associated with a particular card. it’s useful when you need to access or download files, documents, or other resources that have been added to a trello card. the endpoint requires both the card’s id and the attachment’s id to pinpoint the exact resource you’re looking for. use this when you need to retrieve or verify attachment details, such as file name, size, or download url, without fetching all attachments on the card.

Action Parameters

Action Response

Retrieves the board information associated with a specific trello card. this endpoint allows you to fetch details about the parent board of a given card, providing context about where the card is located within your trello workspace. use this when you need to understand the broader organizational structure a card belongs to or when you want to access board-level information starting from a specific card. this is particularly useful for applications that need to navigate from card-level operations to board-level views or actions. note that this endpoint only returns information about the board and does not provide details about other cards or lists on that board.

Action Parameters

Action Response

Marks a specific trello board as viewed by the current user. this endpoint is used to update the board’s status, indicating that the user has seen the latest changes or updates on the board. it’s particularly useful for managing notifications and keeping track of which boards have been recently accessed by the user. the endpoint should be called when a user views a board, typically after loading the board’s content or when explicitly marking it as seen. this action may affect the board’s position in the user’s board list and the notification status for recent activities on the board. note that this endpoint only updates the viewed status and does not modify any other board properties or content.

Action Parameters

Action Response

Retrieves the board associated with a specific trello action. this endpoint allows you to fetch detailed information about the board on which a particular action occurred. it’s useful when you need to understand the context of an action, such as determining which board a card was moved to or where a comment was added. this tool is particularly helpful for tracking the flow of work across different boards or for auditing purposes. note that while it provides board details, it doesn’t return information about the action itself or other board elements like lists or cards.

Action Parameters

Action Response

This endpoint allows you to update the avatar image for a specific trello member. it’s used when you want to change or set a new profile picture for a user in trello. the endpoint accepts a base64-encoded image file and associates it with the specified member’s profile. this is useful for personalizing user profiles or updating outdated avatars. note that this endpoint only changes the avatar and does not modify any other member information. ensure you have the necessary permissions to modify the specified member’s profile before using this endpoint.

Action Parameters

Action Response

Retrieves the list of custom board backgrounds associated with a specific trello member. this endpoint allows you to fetch all personalized background images that the member has uploaded or created for use on their trello boards. it’s useful for applications that need to display or manage a member’s custom board background options. the endpoint returns details about each custom background, which may include image urls, dimensions, and other relevant metadata. use this when you need to access a member’s personal board customization options or integrate board background management into your application.

Action Parameters

Action Response

Updates the name of the purple label on a specific trello board. this endpoint allows you to customize the purple label’s name to better fit your project’s needs or organizational system. use this when you want to change how the purple label is displayed across all cards on a particular board. this action affects only the purple label and does not modify other color labels or any other board properties. the new label name will be immediately reflected on all cards using the purple label on the specified board.

Action Parameters

Action Response

Updates the user’s preference for showing or hiding the sidebar on a specific trello board. this endpoint allows users to customize their board view by toggling the sidebar visibility. it should be used when a user wants to change their personal sidebar display preference for a particular board. the change only affects the current user’s view and does not impact other team members’ preferences. this tool is useful for users who want to maximize their workspace or prefer a cleaner board interface.

Action Parameters

Action Response

The batchrequest endpoint allows you to execute multiple trello api requests in a single http call. this powerful feature enables efficient bulk operations and reduces network overhead. use this endpoint when you need to perform multiple, potentially independent operations on trello resources (such as boards, lists, or cards) simultaneously. the batch request is particularly useful for complex workflows or when synchronizing data between trello and external systems. keep in mind that there may be rate limits or restrictions on the number of requests allowed in a single batch call. this endpoint does not support mixing different http methods within a single batch request.

Action Parameters

Action Response

Retrieves detailed information about the organization (workspace) associated with a specific trello board. this endpoint allows you to fetch organizational data such as the workspace name, description, visibility settings, and other relevant details directly linked to the specified board. use this endpoint when you need to understand the broader context of a board within its organizational structure, such as determining workspace-level permissions or identifying other boards that might be part of the same workspace. this tool is particularly useful for applications that manage multiple trello boards across different organizations or for those that need to sync organizational data with external systems. note that this endpoint only provides information about the organization and does not return data about the board itself or its contents.

Action Parameters

Action Response

Adds a specific label to a trello card. this endpoint allows you to associate an existing label with a particular card, enhancing the card’s categorization and visual organization on the board. use this when you need to tag a card with a predefined label, such as for priority levels, project phases, or any custom categories your team uses. the endpoint requires the card’s id in the url path and the label’s id in the request body. it’s important to note that this endpoint only adds existing labels; it cannot create new labels or modify label properties. ensure that both the card and the label exist before making this api call.

Action Parameters

Action Response

This endpoint allows you to update the “selfjoin” preference for a specific trello board. the “selfjoin” preference determines whether users can join the board on their own or if they need an invitation. when set to ‘true’, users can join the board without an invitation, while ‘false’ requires an invitation from a board admin. this is particularly useful for managing access control and collaboration settings on your trello boards. use this endpoint when you need to change the board’s accessibility, either opening it up for self-joining or restricting access to invite-only.

Action Parameters

Action Response

Updates an existing webhook in trello, allowing you to modify its attributes such as description, active status, callback url, and the model it’s monitoring. this endpoint is used when you need to change the configuration of a webhook, such as activating or deactivating it, updating the url where notifications are sent, or changing which trello object it’s tracking. it’s particularly useful for maintaining and managing long-lived integrations between trello and external systems. the update is performed by sending a put request with the new webhook attributes in the request body.

Action Parameters

Action Response

Retrieves detailed information about a specific check item within a particular checklist in trello. this endpoint is used when you need to access the properties of an individual task or subtask represented by a check item, such as its name, completion status, or position within the checklist. it’s particularly useful for applications that need to display or process individual checklist items, for example, to show task progress or to update task details in an external system. this operation only fetches data and does not modify the check item or checklist. note that you must have appropriate permissions to access the specified checklist and its items.

Action Parameters

Action Response

Retrieves a filtered list of members belonging to a specified trello organization. this endpoint allows you to fetch member information based on certain criteria, making it useful for managing team rosters, analyzing organization structure, or performing member-specific operations. the endpoint requires both the organization id and a filter parameter, enabling precise control over the returned member set. it’s particularly valuable when you need to access specific subsets of an organization’s membership, such as all active members or only administrators. however, it does not modify any data and should be used solely for retrieving member information. note that the exact filtering options and the structure of returned member objects are not specified in the schema, so refer to the latest trello api documentation for the most up-to-date details on available filters and response format.

Action Parameters

Action Response

Creates a new list within a specified trello board. this endpoint allows users to add a custom list to their board, optionally copying from an existing list, setting its position, and defining its initial state. it’s particularly useful for organizing tasks, creating new workflow stages, or expanding board structure. the new list can be created open or closed, and the creating user can choose to subscribe to it for notifications. this tool should be used when setting up new projects, restructuring workflows, or expanding existing boards. it doesn’t modify existing lists or move cards between lists.

Action Parameters

Action Response

Retrieves the recent changes (deltas) for a specified trello organization. this endpoint is used to fetch updates or modifications made within the organization, such as changes to boards, lists, or cards. it’s particularly useful for keeping external systems in sync with trello data or for auditing purposes. the endpoint returns delta information, which may include creation, updates, or deletion of various elements within the organization. note that the specific format and content of the delta information are not detailed in the provided schema.

Action Parameters

Action Response

Adds a new checklist to a specified trello card. this endpoint allows you to create a new checklist from scratch, copy an existing checklist, or add an existing checklist to the card. it’s useful for organizing tasks within a card, breaking down larger tasks into smaller, manageable steps. use this when you need to add a list of to-do items or a set of subtasks to a card. the checklist can be populated with items immediately by copying from an existing checklist, or it can be created empty for later population. this endpoint is particularly helpful for standardizing workflows or replicating common task lists across different cards.

Action Parameters

Action Response

Updates the position of a specific board star for a trello member. this endpoint allows you to change the order of starred boards in a member’s list of favorites. use this when a member wants to reorganize their starred boards, prioritizing certain boards by moving them up or down in the list. the position can be set to predefined values like ‘top’ or ‘bottom’, or a specific numerical position. this operation only affects the order of starred boards for the specified member and does not impact the board itself or its visibility to other members.

Action Parameters

Action Response

This endpoint allows you to update the name of a specific trello list. it’s used when you need to rename a list, perhaps due to changes in project scope, team reorganization, or simply to correct a typo. the endpoint accepts the list’s unique identifier and the new name as parameters. it’s important to note that while this operation changes the list’s name, it doesn’t affect the cards within the list or its position on the board. use this endpoint when you need to quickly update a list’s name without making any other changes to its contents or location.

Action Parameters

Action Response

This endpoint deletes a specific saved search for a trello member. saved searches allow users to quickly access frequently used search terms and filters within trello. this operation permanently removes the saved search from the member’s account, freeing up space and decluttering their saved searches list. use this endpoint when a user wants to remove an outdated or no longer needed saved search. it’s important to note that this action cannot be undone, so confirmation from the user before deletion is recommended. the endpoint requires both the member’s id and the specific saved search id to ensure precise targeting of the item to be deleted.

Action Parameters

Action Response

This endpoint allows for the deletion of a specific custom board background associated with a trello member. it removes the background image from the member’s available board backgrounds, making it no longer accessible for use on their boards. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint is particularly useful for managing storage space or removing outdated or unwanted background options for a member. it requires both the member’s id and the specific board background id to ensure precise targeting of the background to be deleted.

Action Parameters

Action Response

Updates the card associated with a specific checklist in trello. this endpoint allows you to move a checklist from one card to another, which is useful for reorganizing tasks or transferring checklists between different cards in your trello boards. it’s particularly helpful when restructuring workflows or when a set of tasks (represented by the checklist) needs to be reassigned to a different card. the operation requires the id of the checklist to be moved and the id of the destination card. note that this action will remove the checklist from its current card and attach it to the specified new card.

Action Parameters

Action Response

Moves all cards from a specified trello list to a different board. this endpoint is useful for bulk transferring cards when reorganizing projects or merging boards. it allows users to quickly relocate an entire list’s content to a new board without manually moving each card. the operation is irreversible, so it should be used with caution. note that this action only moves the cards; it does not copy them or affect the original list structure.

Action Parameters

Action Response

Retrieves detailed information about a specific user’s membership on a trello board. this endpoint allows you to fetch the membership details, including the member’s role, permissions, and any custom fields associated with their membership on the specified board. it’s particularly useful when you need to verify a user’s access level or retrieve specific attributes of their membership. the endpoint should be used when you require in-depth information about a single membership, rather than a list of all memberships on a board. note that this endpoint only provides read access to membership data and cannot be used to modify the membership.

Action Parameters

Action Response

Retrieves the member information associated with a specific action in trello. this endpoint is used to identify and fetch details about the user who performed a particular action on a trello board, such as moving a card or updating a list. it’s particularly useful for tracking user activities and understanding who made certain changes within a board. the endpoint returns member data related to the action, which may include the user’s id, username, and other relevant information. this tool should be used when you need to connect an action with its performer or when auditing board activities. note that it only provides information about the member in the context of the specified action and does not give a comprehensive view of the member’s overall trello account or activities.

Action Parameters

Action Response

Adds a new comment to a specific trello card. this endpoint allows users to contribute to the conversation on a card by adding textual comments. it’s useful for providing updates, asking questions, or engaging in discussions related to the card’s content or progress. the comment can include mentions of other users and references to other trello elements. this endpoint should be used when you need to programmatically add comments to cards, such as for automated notifications or integrations with other systems. note that while this endpoint adds comments, it does not support attaching files directly - attachments would need to be handled separately.

Action Parameters

Action Response

The getmemberfield endpoint retrieves a specific attribute or property of a trello member. it allows you to fetch granular information about a user without retrieving their entire profile. this endpoint is particularly useful when you need only a single piece of information about a member, such as their full name, username, or a custom field value. it can be used to efficiently update or display specific member details in your application. however, it’s important to note that this endpoint will only return the value of the requested field and not provide any additional context or related information about the member.

Action Parameters

Action Response

Deletes a specific checklist from a trello board. this endpoint should be used when you want to permanently remove a checklist and all its associated items from a card. it’s particularly useful for cleaning up completed or obsolete checklists, or when restructuring card content. the operation is irreversible, so use it with caution. once deleted, the checklist and its items cannot be recovered. this endpoint does not return the deleted checklist data; it typically returns a success status code upon successful deletion.

Action Parameters

Action Response

Updates the bio of a specified trello member. this endpoint allows you to modify the personal or professional description associated with a member’s profile. it’s particularly useful for maintaining up-to-date information about team members within a trello workspace. the bio can be used to provide context about a member’s role, expertise, or any other relevant information that helps in team collaboration. this endpoint should be used when there’s a need to change or refresh a member’s bio information. note that while the bio can be set to an empty string, it has a maximum length of 16,384 characters, allowing for quite detailed descriptions if needed.

Action Parameters

Action Response

Retrieves the list information for a specific card in trello. this endpoint allows you to determine which list a particular card belongs to on a trello board. it’s useful for understanding the current status or position of a task within a workflow. the endpoint should be used when you need to know the organizational context of a specific card, such as its current stage in a process or its categorization. it provides a quick way to locate a card within the board’s structure without having to fetch and search through all lists. note that this endpoint only returns information about the list containing the card and does not provide details about the card itself or other cards in the same list.

Action Parameters

Action Response

This endpoint updates the description of a specific trello webhook. it allows users to modify the textual description associated with a webhook, providing context about its purpose or any relevant notes. the endpoint should be used when there’s a need to change or clarify the purpose of an existing webhook. it’s important to note that this operation only affects the description and does not modify other attributes of the webhook such as its callback url or active state. the description can be set to any string, including an empty string to remove the existing description.

Action Parameters

Action Response

Updates the position of a specific trello card within its current list. this endpoint allows you to move a card to the top, bottom, or a specific position in its list, helping to reorganize tasks and priorities. use this when you need to change the order of cards in a list without changing the list itself. the new position is specified using either keywords (‘top’, ‘bottom’) or a numeric value, providing flexibility in card arrangement. this operation is particularly useful for reordering tasks, adjusting priorities, or maintaining a specific workflow sequence within a trello board.

Action Parameters

Action Response

Retrieves a specific field of information about organizations that a trello member has been invited to join but has not yet accepted. this endpoint is useful for gathering detailed information about pending organization invitations for a user, allowing applications to display relevant data or make decisions based on the invited organizations’ attributes. it provides a focused way to access organization data without fetching all details, which can be more efficient when only specific information is needed. the endpoint should be used when you need to access particular details about organizations a member has been invited to, rather than retrieving full organization objects or listing all invitations.

Action Parameters

Action Response

Retrieves a specific field of information about members invited to a particular trello board. this endpoint is useful when you need to access targeted details about invited members without fetching their full profiles. it can be used to gather information such as email addresses, usernames, or full names of invited members, depending on the specified field. the endpoint is particularly helpful for board administrators or integration tools that need to manage or review board invitations. note that this endpoint only provides information about invited members who have not yet joined the board, not current board members.

Action Parameters

Action Response

Retrieves a specific field from the board associated with a given checklist in trello. this endpoint allows users to access granular information about a board linked to a particular checklist, which can be useful for various integration and automation scenarios. it provides a way to fetch individual board attributes without retrieving the entire board object, potentially improving efficiency for targeted data retrieval. the endpoint should be used when you need to access specific board details in the context of a checklist, but it will not provide information about the checklist itself or other board fields not specified in the request.

Action Parameters

Action Response

Updates the subscription status of a specified trello list. this endpoint allows users to subscribe to or unsubscribe from a list, controlling whether they receive notifications about changes to that list. it’s useful for managing notification preferences on a per-list basis, helping users stay informed about relevant updates while avoiding unnecessary notifications. the endpoint should be used when a user wants to change their subscription status for a specific list, either to start receiving updates or to stop receiving them.

Action Parameters

Action Response

Updates the text content of a specific trello action. this endpoint allows you to modify the text associated with an existing action, such as editing a comment or updating a description. it should be used when you need to correct, clarify, or expand upon the information in an action’s text. the endpoint is particularly useful for maintaining accurate and up-to-date records of activities and communications within trello boards and cards. note that this operation only affects the text content and does not change other properties of the action or its relationships to cards, boards, or other trello elements.

Action Parameters

Action Response

Retrieves the deltas (changes or updates) for a specified trello board. this endpoint allows you to fetch recent modifications made to the board, including changes to lists, cards, and other board elements. it’s particularly useful for synchronizing board data with external systems or monitoring board activity. the endpoint returns a list of changes since the last known state, enabling efficient tracking of board updates without fetching the entire board content. use this when you need to keep an external system up-to-date with trello board changes or when implementing real-time board activity monitoring.

Action Parameters

Action Response

This endpoint updates the read status of a specific trello notification. it allows users to mark a notification as read or unread, which is essential for managing notification states and keeping track of important updates. the endpoint should be used when a user interacts with a notification, such as viewing it or deciding to keep it unread for later review. it’s particularly useful for applications that need to sync notification states between trello and external systems. note that this endpoint only updates the ‘unread’ status and cannot modify other attributes of the notification.

Action Parameters

Action Response

Adds a new board background to a specific trello member’s collection. this endpoint allows users to upload and configure custom background images for their trello boards, enhancing the visual customization of their workspace. the new background can be set with specific brightness levels and tiling options, providing flexibility in how the image is displayed on the board. this tool should be used when a user wants to expand their selection of available board backgrounds or when implementing features that allow for dynamic board customization. note that this endpoint only adds the background to the member’s collection; to apply it to a specific board, an additional api call would be required.

Action Parameters

Action Response

Generates or regenerates a calendar key for a specific trello board. this endpoint is used to create a unique identifier that allows integration between the trello board and external calendar services. the generated key can be used to set up synchronization of board events, due dates, and deadlines with calendar applications. this tool should be used when setting up new calendar integrations or when refreshing existing integrations for security purposes. it’s important to note that generating a new key will invalidate any previous calendar key for the same board, potentially disrupting existing integrations until updated with the new key.

Action Parameters

Action Response

Retrieves detailed information about a specific trello webhook associated with the given token. this endpoint allows developers to fetch the current state and configuration of a webhook, including its callback url, the model it’s watching (e.g., board, list, or card), and its active status. it’s particularly useful for verifying webhook settings, troubleshooting notification issues, or auditing webhook configurations. the endpoint should be used when you need to inspect or confirm the details of an existing webhook. it does not modify the webhook or create new ones, and it won’t return information about other webhooks associated with the token.

Action Parameters

Action Response

Retrieves a list of memberships for a specific trello board. this endpoint allows you to fetch detailed information about the users associated with the board, including their roles (e.g., member, admin, observer) and permissions. use this endpoint when you need to audit board access, manage team members, or gather information about the board’s collaboration structure. it’s particularly useful for large teams or when transitioning project ownership. note that this endpoint only provides membership data and does not include other board details or the actual content of the board.

Action Parameters

Action Response

Updates the status of a specific trello session. this endpoint allows you to change the current state of a user’s session, which can be useful for managing user activity, handling timeouts, or updating session information. use this when you need to reflect changes in a user’s interaction state with trello, such as when a user becomes idle or reconnects after a disconnection. the endpoint is particularly useful for applications that need to maintain accurate session states or implement session management features. note that updating a session status does not create or authenticate a new session; it only modifies the state of an existing one.

Action Parameters

Action Response

Retrieves all boards associated with a specific trello member. this endpoint allows you to fetch a comprehensive list of boards that the member has access to, including boards they own, are members of, or have been invited to. it’s particularly useful for applications that need to display or work with a user’s trello boards, such as for data synchronization, board management, or creating board-related features. the response typically includes details like board ids, names, and other metadata. use this endpoint when you need to get an overview of a member’s trello workspace or when implementing board selection features in your application. note that it only provides board-level information and does not include details about lists or cards within the boards.

Action Parameters

Action Response

Retrieves the list associated with a specific trello notification. this endpoint allows you to fetch details about the list that is linked to a particular notification, providing context for the notification event. use this endpoint when you need to access information about the list where an action triggering a notification occurred. it’s particularly useful for understanding the broader context of a notification, such as which list a card was moved to or where a comment was added. the endpoint returns data specific to the list and does not provide the full notification details or board information. keep in mind that access to this data may depend on the user’s permissions within the trello workspace.

Action Parameters

Action Response

Retrieves all cards associated with a specific member within a trello organization. this endpoint allows you to fetch a comprehensive list of cards that a particular member is involved with in the context of a given organization. it’s useful for getting an overview of a member’s tasks or responsibilities across various boards within the organization. the endpoint returns card data without any sorting or filtering options, providing a complete picture of the member’s card assignments. use this when you need to audit a member’s workload, track their contributions, or gather data for reporting purposes within an organizational context.

Action Parameters

Action Response

Retrieves all labels associated with a specific trello board. this endpoint allows users to fetch the complete set of labels used for categorizing cards within the specified board. it’s particularly useful for getting an overview of the board’s organization system or when preparing to add or update labels on cards. the endpoint returns label information such as names, colors, and ids, which can be used in other api calls for label management or card updates. note that this endpoint only provides label data and does not include information about which cards are using each label.

Action Parameters

Action Response

Updates the attributes of labels on a specific trello card. this endpoint allows you to modify the color, name, and scope of labels associated with a card, enabling better organization and visual categorization of tasks. use this when you need to change the appearance or description of labels on a card, or when you want to update multiple labels at once. the endpoint is particularly useful for bulk updates or when synchronizing label information from external systems. note that this operation will override existing label attributes, so care should be taken to include all desired label information in the request.

Action Parameters

Action Response

Retrieves a specific field of information from all boards that a trello member has been invited to join. this endpoint is useful for gathering particular details about boards where the member has a pending invitation, without fetching all board data. it can be used to quickly check certain attributes across multiple invited boards, such as their names, ids, or last activity dates. this tool is particularly helpful when you need to analyze or display specific information about a member’s board invitations efficiently. note that this endpoint only provides data for boards with pending invitations and does not include boards where the member is already active.

Action Parameters

Action Response

Retrieves the organization information associated with a specific trello action. this endpoint allows you to trace back an action to its parent organization, providing valuable context for auditing, reporting, or analysis purposes. use this when you need to identify which organization an action belongs to or when you want to gather more details about the organization context of a particular trello activity. the endpoint returns organization data such as name, id, and other relevant details. it’s particularly useful for applications that need to track actions across different organizational boundaries or for maintaining a clear audit trail of activities within trello.

Action Parameters

Action Response

This endpoint updates the closed status of a specific trello card. it allows you to mark a card as closed (completed) or open (active) by setting its ‘closed’ attribute. use this endpoint when you need to change the completion status of a task represented by a trello card. the operation is particularly useful for automating workflow processes, such as closing cards when tasks are finished or reopening them if further action is required. note that closing a card doesn’t delete it or move it to the archive; it simply marks it as completed within its current list. this endpoint should be used judiciously as it directly affects the visible state of cards on trello boards.

Action Parameters

Action Response

Updates the website url associated with a specific trello organization. this endpoint allows you to modify or remove the external website link for an organization, which can be useful for maintaining up-to-date references to team or company websites. use this when you need to change the url displayed on the organization’s trello page or remove it entirely. the update is applied immediately, and all members of the organization will see the new website link (or its absence) upon the next page refresh. note that this endpoint only modifies the website url and does not affect any other organization attributes.

Action Parameters

Action Response

Creates a new trello board with customizable attributes and settings. this endpoint allows you to set up a board tailored to your project needs, including its name, description, organization affiliation, and various preferences. you can create a board from scratch or copy an existing one, making it versatile for different use cases. use this when setting up a new project, team workspace, or when you need to replicate an existing board structure. the endpoint offers extensive customization options, from basic details to advanced settings like permissions, power-ups, and visual preferences. note that while many parameters are optional, setting them during creation can save time in subsequent board setup and configuration.(DEPRECATED use add_boards)

Action Parameters

Action Response

This endpoint updates the board visibility restriction preferences for public boards within a trello organization. it allows organization administrators to control who can create or change boards to public visibility. this setting is crucial for managing the organization’s data exposure and collaboration boundaries. use this endpoint when you need to modify the organization-wide policy for public board creation. it’s particularly useful for enhancing security, managing workspace settings, or adjusting collaboration policies as the organization’s needs evolve.

Action Parameters

Action Response

This endpoint updates the card covers preference for a specific trello board. it allows you to enable or disable the display of card covers, which are visual elements (images or colors) shown on the front of trello cards. use this endpoint when you want to change the appearance of cards across an entire board, either to show more visual information at a glance or to create a more streamlined view. the change affects all users viewing the board. note that this update only controls the visibility of existing card covers; it does not add or remove cover images from individual cards.

Action Parameters

Action Response

Updates the name of a specified trello organization. this endpoint allows you to change the unique identifier of an organization, which is used across the trello platform. it should be used when you need to rebrand or rename an organization. the new name must follow strict formatting rules to ensure consistency and avoid conflicts with other organizations. this operation is irreversible and will immediately affect all members and boards associated with the organization, so use it cautiously. note that this endpoint only updates the organization’s name and does not modify any other attributes or settings of the organization.

Action Parameters

Action Response

The searchtrello endpoint allows users to perform a comprehensive search across their trello workspace, including boards, cards, and lists. it’s designed to help users quickly find specific items or information within their trello ecosystem. this endpoint is particularly useful when you need to locate content across multiple boards or when you’re unsure which board contains the information you’re seeking. the search functionality is versatile, matching keywords in titles, descriptions, and other text fields of trello objects. while it provides a powerful way to find information, it’s important to note that the search results are limited to the user’s accessible trello content and may not include recently created or modified items due to indexing delays.(DEPRECATED use get_search)

Action Parameters

Action Response

Retrieves a list of boards that a specific trello member has been invited to but may not have joined yet. this endpoint is useful for tracking pending board invitations for a user, allowing them to see which boards they have access to join. it can be used to display a list of available boards to a user, helping them manage their trello workspace connections. the endpoint does not provide information about boards the member is already part of, focusing solely on outstanding invitations. use this when you need to show a user their pending board invitations or to check if a specific invitation exists for a member.

Action Parameters

Action Response

Updates the card aging preference for a specific trello board. this endpoint allows users to toggle between ‘pirate’ and ‘regular’ card aging modes, which visually represent card inactivity on the board. use this when you want to change how inactive cards are displayed, either for better visibility or to align with team preferences. the change affects all cards on the specified board. note that this endpoint only modifies the card aging setting and does not impact other board preferences or card contents.

Action Parameters

Action Response

This endpoint adds a new check item to an existing trello checklist. it allows users to create and position new tasks or items within a checklist, enhancing the organization and tracking of work items on a trello board. the endpoint should be used when adding new subtasks or items to a checklist, such as when breaking down a larger task into smaller, actionable steps. it provides flexibility in naming the item, setting its initial completion status, and positioning it within the checklist. however, it does not allow for adding multiple items at once or updating existing items - separate api calls would be needed for those operations. the checklist id must be known and provided in the url path when making this api call.

Action Parameters

Action Response

This endpoint archives all cards within a specified trello list. it provides a convenient way to bulk archive multiple cards simultaneously, helping users clean up and organize their trello boards efficiently. the operation is irreversible through this endpoint, so it should be used with caution. this tool is particularly useful when closing out completed projects, clearing inactive lists, or performing board-wide cleanups. note that while cards are archived, they are not deleted and can still be accessed or restored through trello’s archive feature.

Action Parameters

Action Response

Retrieves detailed information about a specific board star for a given trello member. a board star represents a member’s favorite or frequently accessed board. this endpoint allows you to fetch the properties of a particular board star, such as the associated board, its position in the member’s star list, and when it was created or last modified. use this endpoint when you need to access or verify the details of a specific board star for a member, for example, to check if a board is still starred or to retrieve its current position in the member’s favorites. this endpoint is read-only and does not modify any data.

Action Parameters

Action Response

Creates a new checklist in trello, either on a board or within a specific card. this endpoint allows you to add a customizable checklist to organize tasks and track progress. you can create an empty checklist or copy an existing one, specify its name, and set its position. use this when you need to add a new set of to-do items or a list of tasks to be completed. this is particularly useful for breaking down larger tasks into manageable steps or creating standardized processes across different cards or boards. note that while you can create the checklist structure with this endpoint, adding individual checklist items requires separate api calls.

Action Parameters

Action Response

Retrieves the display information for a specific trello action. this endpoint is used to fetch formatted or user-friendly representations of action data, which can be helpful for presenting action details in a more readable or visually appealing manner. it’s particularly useful when you need to show action information in a user interface or generate reports. the endpoint focuses solely on display-related data and does not provide full action details or modify the action in any way. use this when you need to present action information to users or need a simplified view of action data for display purposes.

Action Parameters

Action Response

Retrieves a filtered list of cards associated with a specific trello member. this endpoint allows you to fetch cards based on their status (open, closed) or visibility to the member. it’s particularly useful for getting an overview of a member’s tasks or responsibilities across different boards. the endpoint can be used to gather data for personal task management, team progress tracking, or generating reports on member activities. note that the results are limited to cards the authenticated user has permission to view, and the response may be paginated for large sets of cards.

Action Parameters

Action Response

Deletes a specific check item from a checklist within a trello card. this endpoint allows for the removal of individual tasks or items from a checklist, helping to manage and organize the progress of a card. it should be used when a task is no longer relevant, has been completed and needs to be removed, or was added by mistake. the operation is permanent and cannot be undone through the api, so it should be used with caution. this endpoint is particularly useful for automating task management workflows or cleaning up completed items in a checklist.

Action Parameters

Action Response

Retrieves the entities associated with a specific trello notification. this endpoint allows you to fetch detailed information about the objects (such as boards, lists, cards, or members) that are related to or affected by a particular notification. it’s useful when you need to gather more context about a notification or update your application’s state based on the notification details. the endpoint should be used when you have a notification id and need to know what trello entities are involved in that notification. it will not provide information about notifications themselves, only the related entities.

Action Parameters

Action Response

Creates a new session in trello, associating it with a specific board and setting the user’s status. this endpoint is used to initialize a user’s interaction with a trello board, enabling real-time updates and status tracking. it’s particularly useful for applications that need to manage user presence and activity within trello boards. the created session allows trello to send appropriate notifications and updates based on the user’s status. note that this endpoint doesn’t handle authentication itself; ensure proper authentication is in place before calling this endpoint.

Action Parameters

Action Response

Retrieves information about members who have been invited to a specific trello board but have not yet joined. this endpoint is useful for tracking pending invitations and managing board access. it allows you to view details of invited members, such as their names, email addresses, and the status of their invitations. use this when you need to review or follow up on outstanding board invitations. note that this endpoint only provides information about invited members, not active board members or other board details.

Action Parameters

Action Response

Updates the orange label name for a specific trello board. this endpoint allows you to customize the name of the orange label, which can be used to categorize and prioritize cards on the board. the new label name can be any string up to 16384 characters, including an empty string to remove the current name. use this when you need to modify the orange label’s meaning or purpose for a particular board, enhancing your team’s organization and workflow. note that this only updates the name of the orange label and does not affect any cards currently using this label.

Action Parameters

Action Response

Retrieves detailed information about a specific trello list using its unique identifier. this endpoint allows you to fetch the properties and metadata of a single list, such as its name, associated board, position on the board, and whether it’s archived. use this endpoint when you need to access or verify the current state and details of a particular list in your trello workflow. it’s particularly useful for applications that need to display list information, check list status, or prepare for operations on the list. note that this endpoint only provides information about the list itself and does not return the cards contained within the list.

Action Parameters

Action Response

Removes an associated domain from a trello organization’s preferences. this endpoint is used to update the email domain restrictions for workspace membership by deleting a previously approved domain. it’s particularly useful for enterprise admins who need to modify organization-wide settings to control access and membership. the operation is irreversible, so it should be used carefully when you want to stop allowing automatic membership for users with email addresses from a specific domain. this endpoint doesn’t return the updated preferences; it only performs the deletion.

Action Parameters

Action Response

Creates a new trello board with customizable attributes and settings. this endpoint allows you to set up a board tailored to your project needs, including its name, description, organization affiliation, and various preferences. you can create a board from scratch or copy an existing one, making it versatile for different use cases. use this when setting up a new project, team workspace, or when you need to replicate an existing board structure. the endpoint offers extensive customization options, from basic details to advanced settings like permissions, power-ups, and visual preferences. note that while many parameters are optional, setting them during creation can save time in subsequent board setup and configuration.

Action Parameters

Action Response

Updates the board of a trello card, effectively moving the card to a different board and list. this endpoint is used when you need to transfer a task or item (represented by a card) from one project or workflow (board) to another. it allows for reorganizing work across different contexts while maintaining the task’s details. the operation requires specifying both the target board and the specific list within that board where the card should be placed. this ensures that the card is properly categorized in its new location. use this endpoint when you need to shift priorities, reassign tasks to different teams, or reorganize your workflow structure. note that moving a card to a new board may affect integrations or automations tied to the original board, so use with caution in automated workflows.

Action Parameters

Action Response

Retrieves the check item states for a specific trello card. this endpoint allows you to fetch the current status (e.g., complete or incomplete) of all checklist items associated with the given card. it’s useful for tracking the progress of tasks within a card or for syncing checklist data with external systems. the endpoint should be used when you need to monitor or update the completion status of checklist items for a particular card. note that this endpoint only provides the states of check items and does not return the full checklist or card details. to get comprehensive card information, you would need to use a separate endpoint.

Action Parameters

Action Response

Updates the avatar source for a specific trello member. this endpoint allows you to change how a member’s avatar is displayed by specifying the source of the avatar image. it’s useful for customizing a member’s profile appearance or removing an existing avatar. the endpoint should be used when you need to programmatically manage a member’s avatar settings, such as during user onboarding or profile updates. note that setting the value to ‘upload’ doesn’t actually upload a new image; it only indicates that a custom upload should be used if available. to upload a new avatar image, you would need to use a separate endpoint (not specified in this schema).

Action Parameters

Action Response

Updates the description of a specified trello organization. this endpoint allows you to modify the textual description associated with an organization, providing more context or information about its purpose, goals, or any other relevant details. use this when you need to change or refresh the description of an organization to better reflect its current state or focus. the new description can be up to 16384 characters long, allowing for detailed information, but it can also be set to an empty string if no description is needed.

Action Parameters

Action Response

Creates a new label on a specific trello board. this endpoint allows users to add a label with a specified color and/or name to organize and categorize cards on the board. the new label can be used to visually distinguish and group cards, enhancing the board’s organization. use this when you need to introduce a new category or status for cards on a particular board. the color and name are both optional, allowing for flexible label creation based on user needs. note that while you can create a label with no color and no name, it’s generally more useful to specify at least one of these attributes for meaningful organization.

Action Parameters

Action Response

Retrieves a specific field of information for members who have been invited to join a trello organization. this endpoint is useful for getting targeted details about pending invitations without fetching all information about invited members. it can be used to check the status of invitations, gather contact information, or verify invitation details. the endpoint is particularly helpful when you need to audit or manage the invitation process for a trello organization. note that this endpoint only provides information about invited members who have not yet joined the organization; it does not include data about active members.

Action Parameters

Action Response

Retrieves a list of organizations associated with a specific trello member, filtered by the given criteria. this endpoint is useful for obtaining information about a user’s organizational affiliations within trello, which can be valuable for user management, permissions setting, or displaying relevant workspaces. the filter parameter allows for narrowing down the results based on the member’s relationship to the organizations. this endpoint should be used when you need to gather information about a user’s organizational context within trello, but it will not provide detailed information about the organizations themselves beyond basic identifiers.

Action Parameters

Action Response

Retrieves a specific field of a trello webhook. this endpoint allows you to fetch individual pieces of information about a webhook without retrieving its entire data structure. it’s useful for quickly checking or verifying specific webhook properties, such as its callback url, associated model id, or active status. the endpoint should be used when you need to access or validate a particular attribute of a webhook without the overhead of fetching all of its details. note that this endpoint doesn’t modify the webhook; it only retrieves information.

Action Parameters

Action Response

This endpoint updates the position of a specific saved search within a trello member’s list of saved searches. it allows for reordering saved searches to prioritize frequently used ones or organize them according to the member’s preference. the endpoint should be used when a member wants to change the order of their saved searches, either by moving a search to the top or bottom of the list, or by specifying a numeric position. this operation is particularly useful for members who have multiple saved searches and want to optimize their workflow by having their most important or frequently used searches easily accessible. note that this endpoint only updates the position of the saved search and does not modify any other attributes of the search or the member’s profile.

Action Parameters

Action Response

Creates a new checklist on a specified trello board. this endpoint allows you to add a named checklist to an existing board, providing a way to organize and track tasks or items within a board. use this when you need to create a new list of to-do items, track project milestones, or add any structured list of tasks to a trello board. the checklist will be empty upon creation; items can be added to it in subsequent operations. this operation is useful for setting up new project structures or preparing boards for upcoming tasks. note that while you can create multiple checklists on a board, each checklist is treated as a separate entity and will need to be managed individually.

Action Parameters

Action Response

This endpoint allows you to update the attributes of a specific trello action, particularly its text content. it is used when you need to modify the description or details of an existing action, such as editing a comment or updating activity details. the endpoint accepts a put request with the action’s unique identifier in the url and the new text content in the request body. it’s important to note that this endpoint only updates the text of the action and cannot be used to change other properties or to create new actions. the updated text must adhere to the length constraints specified in the schema.

Action Parameters

Action Response

Retrieves detailed information about a specific trello label using its unique identifier. this endpoint allows you to fetch the properties of a label, such as its name, color, and associated board. use this when you need to access or verify the details of a particular label within your trello workflow. the endpoint returns only the data for the specified label and does not provide information about other labels or the board structure. it’s particularly useful for applications that need to display or process individual label information.

Action Parameters

Action Response

Retrieves a specific field of information for a trello member associated with the given api token. this endpoint allows for granular access to member data, enabling the retrieval of individual attributes rather than the entire member object. it’s particularly useful when you need to quickly fetch a single piece of information about a member, such as their username or email, without the overhead of retrieving all member details. the endpoint should be used when precise, field-specific member information is required, and can help in reducing data transfer and processing when only particular member attributes are needed. note that the available fields and the information returned may depend on the permissions associated with the provided token and the privacy settings of the member in question.

Action Parameters

Action Response

Creates a new list within a specified trello board. this endpoint allows users to add a custom list to their board, optionally copying from an existing list, setting its position, and defining its initial state. it’s particularly useful for organizing tasks, creating new workflow stages, or expanding board structure. the new list can be created open or closed, and the creating user can choose to subscribe to it for notifications. this tool should be used when setting up new projects, restructuring workflows, or expanding existing boards. it doesn’t modify existing lists or move cards between lists.(DEPRECATED use add_lists)

Action Parameters

Action Response

Updates the attributes of an existing trello checklist. this endpoint allows you to modify various properties of a checklist, including its associated board, card, name, and position. you can also use it to copy items from another checklist. use this endpoint when you need to change the details of a checklist, move it to a different card or board, rename it, reorder it, or populate it with items from another checklist. this is particularly useful for reorganizing tasks, updating project structures, or duplicating checklists across different cards or boards. the endpoint requires the id of the checklist to be updated, which should be provided in the url path.

Action Parameters

Action Response

Retrieves all tokens associated with a specific trello member. this endpoint allows you to fetch the authentication tokens that have been issued for a particular user, which can be useful for managing api access and auditing purposes. it returns a list of token objects, each representing an active token for the specified member. use this endpoint when you need to review or manage the api access granted to a user’s account. note that this endpoint does not provide the actual token values for security reasons, but rather metadata about the tokens such as their id, creation date, and associated app information.

Action Parameters

Action Response

Retrieves all cards within a specified trello list. this endpoint allows users to fetch detailed information about cards in a particular list, providing a comprehensive view of tasks or items within that list. it’s particularly useful for applications that need to synchronize trello data, build custom views of trello boards, or perform bulk operations on cards within a specific list. the endpoint returns an array of card objects, each containing details such as the card’s name, description, due date, and any custom fields. use this endpoint when you need to get an up-to-date snapshot of all cards in a list, but note that it doesn’t provide real-time updates or webhook functionality for card changes.

Action Parameters

Action Response

Retrieves detailed information about a specific trello type using its unique identifier. this endpoint allows developers to fetch the characteristics and properties of various trello object types, such as boards, lists, or cards. it’s useful when you need to understand the structure or capabilities of a particular trello type, which can be essential for working with trello’s data model or implementing type-specific features in your application. the endpoint returns only the type information and does not provide instance-specific data or content related to individual trello objects.

Action Parameters

Action Response

Retrieves information about the list associated with a specific trello action. this endpoint is useful when you need to determine which list was affected by a particular action, such as moving a card or updating a list’s properties. it provides context for action events, helping to track changes across a trello board. use this endpoint when you want to get details about the list involved in a specific action, rather than querying all lists on a board. note that this endpoint focuses solely on the list associated with the action and does not provide information about the action itself or other related entities like cards or board details.

Action Parameters

Action Response

Updates the full name of a specified trello member. this endpoint allows you to change the display name of a user in the trello system. it should be used when a member’s name needs to be corrected, updated due to a legal name change, or adjusted for any other valid reason. the endpoint requires the member’s unique identifier and the new full name value. it’s important to note that this operation only updates the full name and does not affect other profile information. be cautious when using this endpoint, as it directly modifies a user’s identifying information.

Action Parameters

Action Response

Updates the name or text associated with the red label on a specific trello board. this endpoint allows users to customize the red label’s text to better categorize and organize cards on their board. it’s particularly useful when you want to give more meaningful names to color-coded labels, enhancing visual organization and filtering capabilities. the update is applied immediately, affecting all cards that use the red label on the specified board. this endpoint should be used when you need to change the red label’s text without altering its color or creating a new label. note that this operation only affects the red label and does not impact other color labels on the board.

Action Parameters

Action Response

Retrieves detailed information about a specific trello notification. this endpoint allows you to fetch the full details of a single notification based on its unique identifier. use this when you need to access comprehensive information about a particular notification, such as its type, related board or card, creation time, and any associated data. this is particularly useful for displaying notification details in your application or for processing specific notifications as part of your workflow automation. the endpoint will only return data for the specified notification and does not provide a way to fetch multiple notifications in a single request.

Action Parameters