Reference

Create category

Create a new category in Shortcut to organize and group your work items, making it easier to manage projects and track different types of work.

Delete category

Remove a category from your Shortcut workspace when it's no longer needed or has become redundant. This helps keep your project organization clean and prevents team members from accidentally using outdated categories.

Get category

Retrieve detailed information about a specific category in your Shortcut workspace, including its name, description, and associated settings. Use this to verify category details or pull category information for reports and integrations.

List categories

Retrieve all available categories in your Shortcut workspace to understand how work items are organized and classified within your projects.

List category milestones

Retrieve all milestones associated with a specific category to view project phases and timeline markers organized by category. This helps you track progress across related goals and deliverables within your project structure.

List category objectives

Retrieve all objectives associated with a specific category to see your organized goals and strategic initiatives at a glance. This helps you track progress on related business objectives grouped by category.

Update category

Modify the name of an existing category in your Shortcut workspace to better reflect your current organizational structure or naming conventions. This helps keep your project categories accurate and aligned with your team's evolving needs.

Delete custom field

Permanently removes a custom field from your Shortcut workspace, clearing all associated data. Use this when you've finished tracking a metric or property that's no longer relevant to your project management needs.

Get custom field

Retrieve detailed information about a specific custom field in Shortcut, including its name, type, and configuration settings. This helps you understand how your team's custom fields are structured and what data they capture.

List custom fields

Retrieves all custom fields you've created in Shortcut so you can see what extra information you're tracking across your projects and stories.

Update custom field

Modify custom field definitions in your Shortcut workspace, including updating field names, reordering values, adding new options, and removing existing ones. This helps you keep your project tracking structure aligned with your team's evolving needs.

Create doc

Create a new document in Shortcut to store and organize written content like documentation, notes, or project guidelines. This helps teams keep important information centralized and easily accessible within their project management workspace.

Delete doc

Permanently removes a document from Shortcut along with all its associated data. Use this when you need to clean up outdated project documentation or remove sensitive information from your workspace.

Get doc

Retrieve detailed information about a specific document in your Shortcut workspace, including its content and metadata, to access project documentation or notes.

List docs

Retrieve all documentation that you have access to in your Shortcut workspace, helping you quickly find and reference existing project guides, processes, and team knowledge.

List document epics

Retrieve all epics associated with a specific document in Shortcut, helping you see the big-picture initiatives linked to your project documentation.

Search documents

Find specific documents in your Shortcut workspace by searching document titles or filtering by status like archived, created by you, or followed by you. Use this to quickly locate project documentation, meeting notes, or shared resources without manual browsing.

Update Doc

Modify a document's title and content within your Shortcut workspace using markdown or HTML formatting. Keep your project documentation current and automatically notify team members of changes in real-time.

Create epic

Create a new epic in Shortcut to organize and group related work items for larger initiatives or feature releases. Epics help you track progress on major projects and communicate roadmap status to stakeholders.

Create epic comment

Add threaded comments to epics to discuss features, provide feedback, or document decisions with your team directly on the epic itself.

Create epic comment comment

Add replies to existing comments on epic items in your project to keep detailed discussions organized in one place. This helps your team collaborate directly on specific tasks without cluttering your main communication channels.

Create epic health

Tracks the current health status of an epic to keep stakeholders informed about project progress and identify at-risk initiatives at a glance.

Delete epic

Permanently removes an epic and all associated details from your project management workspace. Use this when an epic is no longer needed or was created by mistake.

Delete epic comment

Remove a comment from an epic to clean up outdated feedback or incorrect information that's no longer relevant to your project planning.

Get epic

Retrieve detailed information about a specific epic, including its description, associated stories, timeline, and current status to understand large projects at a glance.

Get epic comment

Retrieves details about a specific comment on an epic to help you understand discussions and decisions around your project roadmap items.

Get epic health

Retrieves the current health status of an Epic, allowing you to quickly assess project progress and identify potential issues at a high level.

Get epic workflow

Retrieves the epic workflow configuration for your workspace, showing how epics move through different stages in your project management process. This helps you understand your team's workflow structure and ensure consistency across how work is organized and tracked.

Link document to epic

Associates documentation files with project epics to keep all related materials organized and accessible in one place. This helps teams quickly find relevant docs when working on major features or initiatives.

List epic comments

Retrieve all comments and discussions on a specific epic to review feedback, decisions, and collaboration history from your team members.

List epic documents

Retrieves all documents attached to a specific epic, helping you access project specifications, design files, and reference materials in one place. This is useful when you need to find all documentation supporting a major feature or initiative.

List epic healths

Retrieve the historical health status records for a specific epic, ordered from most recent to oldest, allowing you to track how project health has evolved over time.

List epic stories

Retrieve all stories associated with a specific epic to see what work items are grouped under a major feature or initiative. This helps you understand the scope and progress of your epic-level goals.

List epics

Retrieve a list of all epics in your project along with their details, helping you see the big-picture initiatives and their status at a glance.

List epics paginated

Retrieve a paginated list of epics from your project to view large-scale initiatives and their details in manageable chunks.

Search epics

Find and filter epics in your project by searching based on specific criteria like name, status, or other parameters. This helps you quickly locate and review large initiatives without manually browsing through all epics.

Unlink document from epic

Remove a document from an epic to reorganize your project structure when documents are no longer relevant to that epic's goals or have been reassigned to different work streams.

Update epic

Modify epic details such as name, description, status, or priority to keep your project roadmap aligned with current goals and team priorities.

Update epic comment

Modify and refine feedback or notes on epic-level work items to keep team discussions accurate and up-to-date as project details evolve.

Update health status

Modify the health status of an Epic or Objective to reflect current progress and risks, keeping your team aligned on project well-being.

Create linked file

Attach external files or documents to Shortcut stories to keep all project-related resources centralized and accessible to your team. This helps maintain a complete record of work without duplicating files across multiple platforms.

Delete file

Remove uploaded files from your Shortcut project to clean up outdated documents, attachments, or resources that are no longer needed.

Delete linked file

Remove attached files or links from your Shortcut stories when they're no longer needed or relevant to the project. This keeps your project documentation clean and organized by removing outdated references.

Get file

Retrieve details about a file you've uploaded to your project, including metadata like file name, size, and upload date.

Get linked file

Retrieve detailed information about a file that's linked to your project, including its metadata and access details to keep your project files organized and accessible.

List files

Retrieve all uploaded files stored in your workspace to locate documents, assets, or resources you need across projects.

List linked files

Retrieve all files that have been linked to stories, epics, or other project items in Shortcut, making it easy to see what documentation, designs, or resources are attached to your work.

Update file

Modify the properties of an uploaded file in Shortcut, such as its name or metadata, without changing the actual file content. This helps you organize and keep your project files properly labeled and easy to find.

Update linked file

Modify the properties of a file that's already linked to a Shortcut story, such as changing its URL, name, or description without needing to remove and re-attach it.

Upload files

Upload one or multiple files directly into Shortcut and optionally link them to a specific story for centralized project documentation. This keeps all project-related assets organized in one place without switching between tools.

Create group

Creates a new group in Shortcut to organize your team, department, or project collectively with customizable properties like name, description, and visual branding.

Get group

Retrieves detailed information about a specific group in your Shortcut workspace, including its name, type, and associated metadata. Use this to programmatically access group details for automation, verification, or integration purposes.

List group stories

Retrieve all stories assigned to a specific group to see what work that team is responsible for. This helps you track group workload and understand project progress by team.

List groups

Retrieves all teams in your Shortcut workspace so you can view and manage the groups of people collaborating on your projects.

Update group

Modify group details in Shortcut, including name, description, color, members, and workflows to keep your team structure organized and up-to-date. Use this operation when you need to adjust group settings or manage team membership without creating new groups.

Create generic integration

Set up a webhook endpoint to automatically receive and process real-time events from your Shortcut projects, enabling seamless integration with your other business tools and workflows.

Delete generic integration

Permanently removes a webhook integration from Shortcut when it's no longer needed, freeing up resources and simplifying your project management setup.

Get generic integration

Retrieve detailed information about a specific webhook integration in your Shortcut workspace, including its configuration and status. Use this to verify webhook settings and troubleshoot integration problems.

Unlink comment thread from slack

Disconnects a comment conversation in Shortcut from its synced Slack thread, stopping the automatic synchronization of replies between the two platforms.

Unlink productboard from epic

Removes the connection between a Shortcut epic and its linked Productboard epic, allowing you to reorganize your product planning without affecting your project management structure.

Create iteration

Create a new time-boxed iteration (sprint) in Shortcut to organize and plan your team's work over a specific period. This helps you structure projects into manageable cycles with defined start and end dates.

Delete iteration

Permanently removes an iteration and all its associated work items from your Shortcut project, helping you clean up your project timeline when iterations are no longer needed.

Disable iterations

Turn off the iterations feature in your workspace, allowing you to manage work using other organizational methods like milestones or custom workflows instead.

Enable iterations

Activates the Iterations feature for your workspace, allowing you to organize and track work in time-boxed sprints or release cycles.

Get iteration

Fetches detailed information about a specific iteration in Shortcut, including dates, status, stories, and progress metrics to help you review sprint performance and plan upcoming work.

List iteration stories

Retrieve all stories assigned to a specific iteration to see what work is planned for that sprint or development cycle. This helps you track progress and understand what your team is working on during a particular timeframe.

List iterations

Retrieves all iterations (sprints or planning cycles) from your Shortcut project, showing their dates, status, and associated work items so you can see your project timeline at a glance.

Search iterations

Find and filter iterations in your Shortcut workspace by specific criteria to locate the sprint or iteration you need. This helps you quickly access the right iteration for planning, status updates, or team coordination.

Update iteration

Modify an existing iteration's details such as dates, team members, labels, and timeframe to keep your project timeline and scope aligned with current needs.

Create label

Create custom labels to organize and categorize your stories in Shortcut, making it easier to track different types of work, priorities, or project phases.

Delete label

Remove a label from your project to clean up outdated categories or reorganize your task management system. This helps keep your project labels focused and relevant as your workflow evolves.

Get label

Retrieve detailed information about a specific label in your project, including its name, color, and associated metadata to understand how stories are categorized.

List label epics

Retrieve all epics associated with a specific label to organize and filter your project work by category or team. This helps you quickly view related initiatives without manually searching through your entire project.

List label stories

Retrieve all stories tagged with a specific label to filter and organize your project work by category, priority, or team focus.

List labels

Retrieve all labels used in your Shortcut workspace to see how stories and tasks are organized and categorized.

Update label

Rename an existing label in Shortcut to better reflect your team's current naming conventions or organizational structure. This helps keep your project management system organized and consistent as your workflows evolve.

Get current member info

Retrieve details about the currently authenticated user in your Shortcut workspace, including their profile information and workspace role. This helps you personalize automations and verify user identity within your project management workflows.

Get member

Retrieve detailed information about a team member including their profile, role, and availability status. This helps you understand your team's structure and individual member details for planning and communication.

List members

Retrieve all members in your workspace to see who has access and their roles within your Shortcut project management account.

List members (slim)

Retrieves a lightweight list of all workspace members with their basic information and active status, ideal when you need quick member references without full profile details.

Create milestone

Create a new milestone in Shortcut to mark significant project checkpoints and track major progress goals for your team.

Delete milestone

Remove a milestone from your project when plans change or a goal is no longer needed. This helps keep your project timeline accurate and focused on current objectives.

Get milestone

Retrieve detailed information about a specific milestone in your project, including its progress, dates, and associated stories. Use this to track project goals and understand how work is advancing toward key deliverables.

List milestone epics

Retrieve all epics associated with a specific milestone to view the major initiatives and deliverables planned for that milestone period.

List milestones

Retrieve all milestones from your Shortcut workspace to view project progress markers and deadlines at a glance.

Search milestones

Find specific milestones in your project by searching across all your milestones using custom criteria. This helps you quickly locate important project checkpoints without manually browsing through your entire milestone list.

Update milestone

Modify milestone details like names, descriptions, and target dates to keep your project timeline accurate and team members aligned on key deliverables.

Create objective

Create a new strategic objective in Shortcut to define high-level goals and track progress toward key business outcomes. This helps you organize work around what matters most and align your team's efforts.

Delete objective

Remove an objective from your project when it's no longer needed, helping you keep your project goals current and organized.

Get key result

Retrieve detailed information about a specific Key Result to view its progress, status, and related metrics. This helps you stay informed on whether your team is tracking toward important business objectives.

Get objective

Retrieve detailed information about a specific Objective in your Shortcut workspace, including its progress, description, and associated members.

List objective epics

Retrieve all epics associated with a specific objective to see the major work initiatives and their progress toward that goal. This helps you understand the scope and breakdown of work needed to achieve your business objectives.

List objectives

Retrieve all objectives your team is currently tracking, including their status, progress, and key details in one view.

Search objectives

Find specific Objectives in your Shortcut workspace using search filters and parameters, then navigate through results with stable pagination to locate the goals you need to track.

Update key result

Modify a key result's name, target value, or current progress to keep your goals aligned with business changes and performance updates.

Update objective

Modify objective properties like title, description, and completion status to keep your goals aligned with current business priorities and progress.

List projects

Retrieve a complete list of all your projects along with their details, helping you get an overview of everything your team is working on.

Create project

Creates a new project in Shortcut to organize and track your team's work, features, and bugs in one centralized location.

Delete project

Removes a project from your Shortcut workspace after ensuring all associated stories have been moved or deleted, helping you maintain a clean project structure.

Get project

Retrieve detailed information about a specific project, including its settings, status, and configuration to understand project details and progress.

Update project

Modify your project's key details like name, description, and settings to keep your team organized and aligned on current priorities. This helps you adapt your project structure as your business needs evolve.

Get repository

Retrieve detailed information about a specific repository including its name, URL, and configuration settings to understand your codebase structure and settings.

List repositories

Retrieve a complete list of all repositories connected to your Shortcut workspace, including their settings and configurations. This helps you understand your project structure and manage your development environment.

Search

Find specific Epics and Stories in your project using search filters and parameters. Use pagination to navigate through results while maintaining consistent ordering across requests.

Create story

Add a new story or task to your Shortcut workspace to organize and track work items. This helps you break down projects into manageable pieces and assign them to your team.

List stories

Retrieve all stories from a selected project to view your team's work items and their current status at a glance.

Search stories

Find specific stories or tasks within your project workspace by searching with filters like status, assignee, or labels. This helps you quickly locate work items without scrolling through entire project lists.

Update story

Modify story details like title, description, status, and assignees to keep your project information current and reflect progress changes in real-time.

Create multiple stories

Quickly add multiple work items to your project in one request, saving time compared to creating stories individually. This is useful when you need to bulk-populate your backlog or import a batch of work items.

Create story comment

Add comments to project stories to collaborate with your team, share updates, and keep all task-related discussions in one centralized place.

Create story from template

Quickly create a new story in Shortcut using a predefined template, ensuring consistency and saving time on repetitive story setup. This is ideal when you need to standardize how similar work items are structured across your projects.

Create story link

Creates semantic relationships between stories to show how they depend on, duplicate, or relate to each other. This helps teams understand task dependencies and avoid duplicate work.

Create story reaction

Add emoji reactions to story comments to provide quick feedback and express agreement without writing additional text.

Delete multiple stories

Remove multiple archived stories from your project in a single action, helping you clean up and maintain a streamlined project workspace. This is useful when you need to bulk-delete completed or obsolete work items.

Delete story

Removes a story from your project when it's no longer needed, such as when a task is cancelled or duplicate work is identified.

Delete story comment

Remove unwanted or incorrect comments from story discussions to keep project communication clean and organized. This helps maintain focused collaboration by deleting outdated, duplicate, or mistaken feedback.

Delete story link

Remove connections between related stories in your project, allowing you to unlink dependencies or relationships that are no longer relevant to your workflow.

Delete story reaction

Remove a reaction you've added to a story comment, allowing you to correct mistakes or change your response to feedback without cluttering your project discussions.

Get external link stories

Retrieve all stories in your project that are linked to a specific external URL or resource, helping you track which work items reference external documentation, tools, or third-party services.

Get story

Retrieve detailed information about a specific story in your project, including its status, assignees, description, and progress tracking. This helps you stay updated on individual work items without leaving your application.

Get story comment

Retrieve the details of a specific comment made on a story, including the commenter's information and comment content. This helps you track feedback, discussions, and decisions documented within your project stories.

Get story link

Retrieves the details of linked stories and their relationships within your project, helping you understand how tasks and work items connect to each other.

List story comment

Retrieve all comments attached to a story to review team feedback, discussions, and updates related to that specific work item.

Search stories old

Find and locate specific stories in your project by searching across title, description, and other parameters to quickly retrieve relevant work items.

Story history

Retrieves a complete chronological record of all changes, updates, and modifications made to a specific story, showing who changed what and when. This helps you track story evolution and maintain transparency across your project work.

Update multiple stories

Batch update multiple stories simultaneously to apply the same changes across multiple tasks, saving time on repetitive updates to your project workflow.

Update story comment

Modify the text content of an existing comment on a story to fix typos, add additional context, or clarify information shared with your team.

Update story link

Modify the connection between two stories or change how they relate to each other, such as updating which stories are blocked by or depend on other stories.

Create task

Create a new task within a story to break down work into smaller, actionable items that your team can track and complete. This helps you manage project progress by organizing work into manageable subtasks.

Update task

Modify task details like status, priority, assignee, or deadline to keep your project information current and reflect real-time progress changes.

Delete task

Remove a task from a story when it's no longer needed, helping keep your project organized and focused on current work.

Get task

Retrieves detailed information about a specific task, including its status, assignee, due date, and other metadata to help you track project progress and task details.

List story sub-tasks

Retrieve all sub-tasks linked to a specific story to view the breakdown of work and track progress on individual components of a larger task.

Create entity template

Define reusable templates for standardizing how your team creates projects, tasks, or stories, ensuring consistency across your workspace.

Delete entity template

Permanently removes a custom entity template from your Shortcut workspace when it's no longer needed or has been replaced by a newer version.

Disable story templates

Turn off the Story Template feature for your workspace to simplify your project setup or prevent team members from using standardized story templates.

Enable story templates

Activates the Story Template feature in your Shortcut workspace, allowing you to create and reuse standardized story templates for consistent project tracking and faster task creation.

Get entity template

Retrieve detailed information about a specific entity template in Shortcut, including its structure and configuration, to understand how work items are organized in your projects.

List entity templates

Retrieve all available entity templates configured for your workspace, enabling you to understand the standard structures and fields used for organizing work across your projects.

Update entity template

Modify the name or content of an entity template to keep your project structure aligned with your evolving team processes and standards.

Get workflow

Retrieve detailed information about a specific workflow including its stages, settings, and configuration to understand how work is being organized and processed.

List workflows

Retrieve all workflows configured in your workspace to view available automation templates and processes. This helps you understand and manage your team's standardized workflows.