# Superthread help center

## Docs

- [API terminology](https://superthread.com/docs/api-docs/api-terminology.md): Some of the legacy names that may be used throughout our API
- [Authentication](https://superthread.com/docs/api-docs/auth.md): How to make requests to the Superthread API
- [Create a board](https://superthread.com/docs/api-docs/boards/create-a-board.md): Allows the creation of a new board within a workspace (`team_id`). The request body should contain the board's title, layout, lists, members, and other optional metadata. Specify the project ID to associate the board with a space.
- [Create a list](https://superthread.com/docs/api-docs/boards/create-a-list.md): Creates a new list (also called a status or column) within a board. The request body must include the `board_id` that the list should belong to.
- [Delete a board](https://superthread.com/docs/api-docs/boards/delete-a-board.md)
- [Duplicate a board](https://superthread.com/docs/api-docs/boards/duplicate-a-board.md): Duplicates an existing board into a specified space (project). The request body allows customization of the title and associated project ID.
- [Get a board](https://superthread.com/docs/api-docs/boards/get-a-board.md): Returns detailed information about a specific board identified by its unique ID within a workspace (`team_id`). This includes metadata and settings configured for the board.
- [Get boards](https://superthread.com/docs/api-docs/boards/get-boards.md): Fetches a list of all boards within a specified workspace (`team_id`). Query parameters allow filtering based on bookmarked status or archived boards. Use the `project_id` parameter to specify the associated space.
- [Update a board](https://superthread.com/docs/api-docs/boards/update-a-board.md): Updates the specified fields of a board. Fields omitted in the request will remain unchanged.
- [Update a list](https://superthread.com/docs/api-docs/boards/update-a-list.md): Updates the specified list (`list_id`) in a workspace (`team_id`). The request body contains the fields to modify, while omitted fields remain unchanged.
- [Add related card](https://superthread.com/docs/api-docs/cards/add-related-card.md): Creates a relationship between a specified card (`card_id`) and another card using a defined link type (`blocks`, `blocked_by`, `related`, or `duplicates`). This relationship helps visualize dependencies or connections between cards. A 200 response includes details of the linked card.
- [Add tags to a card](https://superthread.com/docs/api-docs/cards/add-tags.md): Attaches one or more tags to a specified card (`card_id`) within a workspace (`team_id`). Tags are used to categorize or organize cards for easier filtering and tracking. The request body can include a single tag (id) or multiple tags (ids), but one of `id` or `ids` must be specified. A 204 response…
- [Archive a card](https://superthread.com/docs/api-docs/cards/archive-a-card.md): Update a card's attributes or archive/unarchive it.
- [Create a card](https://superthread.com/docs/api-docs/cards/create-a-card.md): This endpoint allows you to create a new card in a specified team workspace by providing a set of required and optional parameters. Key required fields include:
- [Delete a card](https://superthread.com/docs/api-docs/cards/delete-a-card.md): Deletes a specific card, identified by its `card_id`, within the specified workspace (`team_id`). This action is irreversible and removes all associated data, including linked cards, child cards, tags, and external references. Use this operation cautiously, as it cannot be undone. A 204 response ind…
- [Duplicate a card](https://superthread.com/docs/api-docs/cards/duplicate-a-card.md): Creates a duplicate of a specified card (`card_id`) within the same or another list/board. The copied card retains its content, child cards, and other attributes. The request body specifies the new card's details, such as the target list_id, board_id, and project_id. A 200 response contains the deta…
- [Get a card](https://superthread.com/docs/api-docs/cards/get-a-card.md): Retrieves detailed information about a specific card, identified by its `card_id` within a workspace (`team_id`). The response includes metadata such as the card's title, content, status, owner, priority, associated tags, and links to related items. Child cards, linked cards, and any collaboration o…
- [Get cards assigned to a user](https://superthread.com/docs/api-docs/cards/get-cards.md): This endpoint provides a preview of results based on specified filters for boards, cards, or pages. The request includes a type parameter (board, card, or page) and supports advanced filtering criteria, such as time ranges, specific project or member associations, and sorting preferences. Pagination…
- [Get tags](https://superthread.com/docs/api-docs/cards/get-tags.md): This endpoint retrieves a list of tags associated with a workspace (team) and optionally filters them by a specific project if the `project_id` query parameter is provided. It also supports fetching all tags in the workspace with the `all` parameter.
- [Remove a tag from a card](https://superthread.com/docs/api-docs/cards/remove-a-tag.md): Removes a specific tag (`tag_id`) from the specified card (`card_id`) within a workspace (`team_id`). A 204 response indicates the tag was successfully removed.
- [Remove related card](https://superthread.com/docs/api-docs/cards/remove-related-card.md): Deletes an existing link between the specified card (`card_id`) and a linked card (`linked_card_id`). This operation is used to remove relationships between cards. A 204 response indicates the link was successfully removed.
- [Replace a card description](https://superthread.com/docs/api-docs/cards/replace-a-card-description.md): Overwrites the content of a specified card within a workspace (`team_id`). Accepts either raw HTML or structured content which is proxied to the collaboration server.
- [Update a card property](https://superthread.com/docs/api-docs/cards/update-a-card.md): Update a card's attributes or archive/unarchive it.
- [Create a comment](https://superthread.com/docs/api-docs/comments/create-a-comment.md): Adds a new comment to a specified team resource. The request body must include the content field, with optional fields for context, page_id, or card_id.
- [Delete a comment](https://superthread.com/docs/api-docs/comments/delete-a-comment.md): Permanently removes the comment identified by comment_id. Only the original author can delete their own comment.
- [Delete a reply](https://superthread.com/docs/api-docs/comments/delete-a-reply.md): Deletes a specific child comment (`child_comment_id`) associated with a parent comment (`comment_id`) in a workspace (`team_id`). Only the original author of the child comment can delete it.
- [Edit a comment](https://superthread.com/docs/api-docs/comments/edit-a-comment.md): Modifies the fields of an existing comment. Only the original author can modify comments. The request body should specify the fields to update, such as content, status, or context. Omitted fields will remain unchanged. The status field accepts the following values: resolved, open, orphaned.
- [Edit a reply](https://superthread.com/docs/api-docs/comments/edit-a-reply.md): Updates the content or metadata of a specific child comment within a team. Only the original author of the child comment can modify it. Required Parameters:
- [Get a comment](https://superthread.com/docs/api-docs/comments/get-a-comment.md): Fetches the details of a single comment identified by comment_id. Includes metadata like author, reactions, and timestamps.
- [Get comments for a resource](https://superthread.com/docs/api-docs/comments/get-comments.md): Fetches a list of comments associated with a specific team resource, e.g. card or page. Optional query parameters allow filtering by page_id, card_id, and one of it must be specified. The comments can further be filtered by the filter parameter, which supports the following values: resolved, open, o…
- [Get replies to a comment](https://superthread.com/docs/api-docs/comments/get-replies.md): Retrieves a list of comments, also known as child comments or replies, associated to a parent comment identified by comment_id. The response includes nested metadata and pagination details.
- [Reply to a comment](https://superthread.com/docs/api-docs/comments/reply-to-a-comment.md): Creates a new child comment under the parent comment specified by comment_id. The request body must include the content field and can optionally include additional metadata such as schema. The child comment can also be referred to as a reply or a thread.
- [Create a note](https://superthread.com/docs/api-docs/notes/create-a-note.md): Creates a new note within the specified workspace (team_id). The note object is provided in the request body, including the note title, content, and any other relevant details (optional fields include transcript and user notes). Upon successful creation, the new note is returned in the response.
- [Delete a note](https://superthread.com/docs/api-docs/notes/delete-a-note.md): Permanently deletes a note identified by `note_id` from the specified workspace (`team_id`). This operation cannot be undone and should be used with caution.
- [Get a note](https://superthread.com/docs/api-docs/notes/get-a-note.md): Retrieves a specific note within the specified workspace (`team_id`). The note is identified by the provided note_id and returned in the response.
- [Get notes](https://superthread.com/docs/api-docs/notes/get-notes.md): Retrieves all notes within the specified workspace (team_id). This endpoint returns an array of notes visible to the current user, enabling a comprehensive view of all accessible notes in the workspace.
- [Archive a page](https://superthread.com/docs/api-docs/pages/archive-a-page.md): Archives a specified page within a workspace (`team_id`). Archiving moves the page to an archived state, making it inaccessible through regular navigation but preserving its data for potential future restoration.
- [Create a page](https://superthread.com/docs/api-docs/pages/create-a-page.md): Creates a new page in the workspace (`team_id`) under a specified space (project). Pages can be associated with a template for efficient creation and can include a title, content, icon, and optional hierarchy settings.
- [Delete a page](https://superthread.com/docs/api-docs/pages/delete-a-page.md): Permanently removes a specified page from the workspace (`team_id`). This action is irreversible.
- [Duplicate a page](https://superthread.com/docs/api-docs/pages/duplicate-a-page.md): Creates a copy of a specified page, allowing users to reuse its content or structure. The new page can be placed under a parent page or at the root of a space (project).
- [Get a page](https://superthread.com/docs/api-docs/pages/get-a-page.md): Fetches detailed information about a specified page identified by the `page_id` within a workspace (`team_id`).
- [Get pages](https://superthread.com/docs/api-docs/pages/get-pages.md): Returns a list of all available pages for the workspace (`team_id`). Pages are organized by spaces (projects) and can be filtered by `archived` or `updated_recently`.
- [Replace a page's content](https://superthread.com/docs/api-docs/pages/replace-a-page-content.md): Overwrites the content of a specified page within a workspace (`team_id`). Accepts either raw HTML or structured content which is proxied to the collaboration server.
- [Update a page property](https://superthread.com/docs/api-docs/pages/update-a-page.md): Modifies properties of a specified page, such as its title, position, and content. Only provided fields will be updated.
- [Add related project](https://superthread.com/docs/api-docs/projects/add-related-project.md): Creates a relationship between a specified card (`card_id`) and another card using a defined link type (`blocks`, `blocked_by`, `related`, or `duplicates`). This relationship helps visualize dependencies or connections between cards. A 200 response includes details of the linked card.
- [Archive a project](https://superthread.com/docs/api-docs/projects/archive-a-project.md): Modify an epic (project) in a workspace (`team_id`). Update fields such as the title, content, due date, priority, and members. Use this endpoint to keep epic details aligned with project updates or changes.
- [Create a project](https://superthread.com/docs/api-docs/projects/create-a-project.md): Create a new epic (referred to externally as a "Project") in a workspace (`team_id`). Specify essential properties such as the title, list ID (status), and optional fields like icon, content, due date, priority, and owner. Customize the epic's icon and assign roles to team members. This endpoint ena…
- [Delete a project](https://superthread.com/docs/api-docs/projects/delete-a-project.md): Delete an epic (project) in a workspace (`team_id`). This operation removes the project but cards associated with the epic remain intact.
- [Get a project](https://superthread.com/docs/api-docs/projects/get-a-project.md): Retrieve all details about an epic (project) in a workspace (`team_id`). Use this endpoint to see the description, progress, tasks and other metadata about a project.
- [Get projects](https://superthread.com/docs/api-docs/projects/get-projects.md): Fetch a list of all epics (projects) within a workspace (`team_id`). Use this endpoint to retrieve the high-level projects, their status and if they are assigned to different individuals or teams.
- [Remove related project](https://superthread.com/docs/api-docs/projects/remove-related-project.md): Deletes an existing link between the specified card (`card_id`) and a linked card (`linked_card_id`). This operation is used to remove relationships between cards. A 204 response indicates the link was successfully removed.
- [Update a project](https://superthread.com/docs/api-docs/projects/update-a-project.md): Modify an epic (project) in a workspace (`team_id`). Update fields such as the title, content, due date, priority, and members. Use this endpoint to keep epic details aligned with project updates or changes.
- [Get search results](https://superthread.com/docs/api-docs/search/get-search-results.md): Execute a search query across multiple workspace entities, including boards, cards, pages, and projects. Customize the search by specifying targeted fields like title or content, filtering by types of objects, or focusing on specific statuses. Additional options include filtering by project, control…
- [Add a member to a space](https://superthread.com/docs/api-docs/spaces/add-member-to-a-space.md): Add one or more users to a project (Space) with specified roles, such as "admin" or "member." This allows the new members to participate in and manage the project's tasks and resources.
- [Create a space](https://superthread.com/docs/api-docs/spaces/create-a-space.md)
- [Delete a space](https://superthread.com/docs/api-docs/spaces/delete-a-space.md): Permanently delete a project (Space) from the specified team (Workspace). This action cannot be undone, and all associated data will be removed.
- [Get a space](https://superthread.com/docs/api-docs/spaces/get-a-space.md): Fetch comprehensive details about a specific project (referred to externally as a "Space") within a team (externally referred to as a "Workspace").
- [Get spaces](https://superthread.com/docs/api-docs/spaces/get-spaces.md)
- [Remove a member from a space](https://superthread.com/docs/api-docs/spaces/remove-member-from-a-space.md): Revoke a user's access to a specific project (Space) within the team (Workspace). The user is identified by their unique ID, and their role and permissions in the project are revoked.
- [Update a space](https://superthread.com/docs/api-docs/spaces/update-a-space.md): Update properties of a project (Space) such as its title, description, privacy settings, and position in the sidebar. You can also set or remove custom icons and adjust estimation systems. All unspecified fields remain unchanged.
- [Create a sprint](https://superthread.com/docs/api-docs/sprints/create-a-sprint.md): Creates a new sprint for the specified project (`project_id`) in a workspace (`team_id`). A sprint can include a title, content, and must reference the `project_id` (externally referenced as Space).
- [Get a sprint](https://superthread.com/docs/api-docs/sprints/get-a-sprint.md): Fetches detailed information for a specific sprint identified by `sprint_id` within the workspace (`team_id`). This includes sprint metadata such as its title, content, start and end dates, and current state.
- [Get sprint settings](https://superthread.com/docs/api-docs/sprints/get-sprint-settings.md): Fetches the sprint settings for the specified project (externally referenced as Space, `project_id`) within a workspace (`team_id`). Includes configurations such as sprint length, layout, statuses, cooldown period, start day of the week, and VCS mappings for automation.
- [Get sprints](https://superthread.com/docs/api-docs/sprints/get-sprints.md): Fetches all sprints for the specified project (externally referenced as Space, `project_id`) within a workspace (`team_id`). status. The response can include active or archived sprints based on the archived query parameter.
- [Update a sprint](https://superthread.com/docs/api-docs/sprints/update-a-sprint.md): Updates the fields of a specific sprint (`sprint_id`) within the workspace (`team_id`). Only the fields provided in the request body will be modified; omitted fields will remain unchanged.
- [Update sprint settings](https://superthread.com/docs/api-docs/sprints/update-sprint-settings.md): Updates the sprint settings for the specified project (externally referenced as Space, `project_id`) within a workspace (`team_id`).
- [Delete a team member](https://superthread.com/docs/api-docs/users/delete-a-team-member.md): Removes a specific member (`user_id`) from a workspace (`team_id`). The member is not deleted but is marked as `inactive` and removed from the team.
- [Get my account](https://superthread.com/docs/api-docs/users/get-my-account.md): Fetches detailed information about a user, including profile details, teams, locale, and other metadata. Indicates if the token used in the request is privileged or outdated. Privileged tokens are necessary for specific sensitive operations like email updates.
- [Get team members](https://superthread.com/docs/api-docs/users/get-team-members.md): Returns a list of all members belonging to a specified team (workspace), along with their roles and other relevant details.
- [Update a team member](https://superthread.com/docs/api-docs/users/update-a-team-member.md): Updates the role of a specific member (`user_id`) within a workspace (`team_id`). Roles can include owner, admin, member, or guest.
- [Update my account](https://superthread.com/docs/api-docs/users/update-my-account.md): Updates user profile fields such as name, profile image, timezone, and company information. Allows selective updates, leaving unspecified fields unmodified. A successful request returns the updated user details.
- [2021](https://superthread.com/docs/changelog/2021.md): Updates and improvements to Superthread in 2021
- [2022](https://superthread.com/docs/changelog/2022.md): Updates and improvements to Superthread in 2022
- [2023](https://superthread.com/docs/changelog/2023.md): Updates and improvements to Superthread in 2023
- [2024](https://superthread.com/docs/changelog/2024.md): Updates and improvements to Superthread in 2024
- [2025](https://superthread.com/docs/changelog/2025.md): Updates and improvements to Superthread in 2025
- [Latest releases](https://superthread.com/docs/changelog/index.md): Latest updates and improvements to Superthread
- [CLI reference](https://superthread.com/docs/cli/index.md): Install and use the Superthread CLI to manage your workspace from the terminal.
- [Claude skill](https://superthread.com/docs/cli/skill.md): The built-in skill that teaches Claude how to use the Superthread CLI.
- [Boards](https://superthread.com/docs/help/boards.md): Learn how to use boards to organize and visualize work in Superthread
- [Card & project comments](https://superthread.com/docs/help/card-project-comments.md): How to use comments on cards and projects in Superthread
- [Cards](https://superthread.com/docs/help/cards-child-cards.md): Learn about cards and how to break down work using child cards in Superthread
- [CLI](https://superthread.com/docs/help/cli.md)
- [Download the app](https://superthread.com/docs/help/download-superthread.md): Learn how to download and install Superthread for macOS and iOS
- [Get in touch](https://superthread.com/docs/help/get-in-touch.md): Learn how to contact the Superthread team, join our community, and stay updated with the latest features
- [GitHub integration](https://superthread.com/docs/help/github-integration.md): Connect Superthread with GitHub to link pull requests to cards and automate status changes
- [Import from Jira](https://superthread.com/docs/help/import-jira.md): Learn how to migrate your Jira projects and issues into Superthread
- [Import from Shortcut](https://superthread.com/docs/help/import-shortcut.md): Learn how to migrate your Shortcut stories and epics into Superthread
- [Import tasks from other tools](https://superthread.com/docs/help/import-task-from-another-tool.md): Learn how to migrate your existing work from Trello, Jira, or Shortcut into Superthread seamlessly
- [Import from Trello](https://superthread.com/docs/help/import-trello.md): Learn how to migrate your Trello boards and cards into Superthread
- [Integrations](https://superthread.com/docs/help/integrations.md): Connect Superthread with your favorite tools to enhance collaboration and automate your workflow
- [Keyboard shortcuts](https://superthread.com/docs/help/keyboard-shortcut.md): Master Superthread's keyboard shortcuts to boost your productivity with quick navigation and common actions
- [MCP](https://superthread.com/docs/help/mcp.md)
- [Mentions](https://superthread.com/docs/help/mentions.md): Learn how to use mentions in Superthread
- [Calendar integration](https://superthread.com/docs/help/note-calendar-integration.md): Connect your Google calendar to Superthread to preview upcoming meetings and receive reminders to start transcribing.
- [Note templates](https://superthread.com/docs/help/note-templates.md): Create your own templates or choose from our library for recurrent meeting types
- [Transcribing meetings](https://superthread.com/docs/help/note-transcription.md): Learn how to use AI-powered transcription to turn your meetings into actionable notes, available for both in-person and virtual meetings
- [Getting started](https://superthread.com/docs/help/notes-quick-start.md): How to get up and running with Superthread notes and transcription
- [Notifications](https://superthread.com/docs/help/notifications-and-inbox.md): Learn how to manage your notifications inbox to stay informed about important updates in your workspace
- [Page comments](https://superthread.com/docs/help/page-comments.md): How to use comments to collaborate within documents
- [Page sharing](https://superthread.com/docs/help/page-sharing.md): Share pages on the web to make them accessible to people outside of your workspace.
- [Pages, subpages, and sharing](https://superthread.com/docs/help/pages-and-subpages.md): Create and manage collaborative documents with rich text, images, and comments to build your team's knowledge base
- [Plans & billing](https://superthread.com/docs/help/plans-billing.md): Compare Superthread plans, manage your subscription, and understand billing options for your workspace
- [Projects](https://superthread.com/docs/help/projects-roadmap.md): Learn how to track large projects on a decidated projects board
- [Quick start guide](https://superthread.com/docs/help/quick-start-guide.md): Essential guide to get you up and running with Superthread, covering workspaces, spaces, boards, and core concepts
- [Search](https://superthread.com/docs/help/search.md): Learn about Superthread's powerful universal search feature
- [Sidebar](https://superthread.com/docs/help/sidebar.md): Learn about the sidebar navigation and features in Superthread
- [Slack integration](https://superthread.com/docs/help/slack-integration.md): Learn how to connect Superthread with Slack to preview links, receive notifications, and keep your team updated
- [Smart links](https://superthread.com/docs/help/smart-links.md): Learn how to use smart links in Superthread
- [Spaces](https://superthread.com/docs/help/spaces.md): Learn how to organize work using spaces in Superthread
- [Sprints](https://superthread.com/docs/help/sprints.md): Learn how to implement and manage time-boxed work periods for your team to deliver work consistently
- [Statuses](https://superthread.com/docs/help/statuses.md): Learn how to use statuses to track work progress in Superthread
- [Tags](https://superthread.com/docs/help/tags.md): Learn how to use tags to organize and categorize cards in Superthread
- [Terminology](https://superthread.com/docs/help/terminology.md): Learn about Superthread's core concepts and how they are used in your workspace.
- [Users & permissions](https://superthread.com/docs/help/users.md): Learn about user roles and permissions in Superthread
- [Saved filters](https://superthread.com/docs/help/views.md): Learn how to use custom filters to create lists of cards from across your workspace
- [Workspace](https://superthread.com/docs/help/workspace.md): Learn how to manage your workspace in Superthread
- [Zapier integration](https://superthread.com/docs/help/zapier-integration.md): Connect Superthread with hundreds of apps through Zapier to automate your workflow
- [Superthread help centre](https://superthread.com/docs/index.md): Complete documentation for all Superthread features and functionality

## OpenAPI Specs

- [superthread](https://superthread.com/docs/superthread.yaml)