Shortcut

Create Category allows you to create a new Category in Shortcut.

Create Doc allows you to create a new document in Shortcut. Use when you need to create documentation, notes, or any written content. Supports markdown or HTML input.

Create a new entity template for the Workspace.

Create Epic allows you to create a new Epic in Shortcut.

This endpoint allows you to create a threaded Comment on an Epic.

This endpoint allows you to create a nested Comment reply to an existing Epic Comment.

Create a new health status for the specified Epic. Use when you need to set or update the health tracking status of an Epic.

Tool to create a generic webhook integration in Shortcut. Use when you need to set up a webhook endpoint to receive Shortcut events.

Creates a new group in the Shortcut system with customizable properties. This endpoint allows you to set up a group with a unique mention name, display name, optional description, and various customization options. Use this when you need to establish a new team, department, or any other collective within your Shortcut workspace. The created group can include members, associated workflows, and visual customizations like color and icon. This endpoint is particularly useful for organizing your Shortcut workspace structure, facilitating team collaboration, and streamlining workflow management. Note that while member and workflow associations can be set during creation, they can also be modified later using separate endpoints.

The CreateIteration endpoint allows you to create a new Iteration in Shortcut, which represents a time-boxed period for completing a set of stories or tasks. This endpoint is crucial for teams using Agile methodologies, enabling them to plan and track progress over specific time periods. Use this endpoint when setting up sprint cycles, planning releases, or organizing work into manageable timeframes. The endpoint requires essential information such as the Iteration's name and date range, while also offering options to add followers, associate groups, and attach labels for better organization and tracking. It's important to note that while multiple groups can be added via the API, the current web UI only displays one Group association. This endpoint should not be used for modifying existing Iterations; instead, use the dedicated update endpoint for such changes.

Create Label allows you to create a new Label in Shortcut.

Create Linked File allows you to create a new Linked File in Shortcut.

(Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone in Shortcut.

Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](https://developer.shortcut.com/api/rest/v3#create-story).

Create Objective allows you to create a new Objective in Shortcut.

Create Project is used to create a new Shortcut Project.

Create Story is used to add a new story to your Shortcut Workspace. This endpoint requires that either **workflow_state_id** or **project_id** be provided, but will reject the request if both or neither are specified. The workflow_state_id has been marked as required and is the recommended field to specify because we are in the process of sunsetting Projects in Shortcut.

Create Comment allows you to create a Comment on any Story.

Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.

Story Links (called Story Relationships in the UI) allow you create semantic relationships between two stories. The parameters read like an active voice grammatical sentence: subject -> verb -> object. The subject story acts on the object Story; the object story is the direct object of the sentence. The subject story "blocks", "duplicates", or "relates to" the object story. Examples: - "story 5 blocks story 6” -- story 6 is now "blocked" until story 5 is moved to a Done workflow state. - "story 2 duplicates story 1” -- Story 2 represents the same body of work as Story 1 (and should probably be archived). - "story 7 relates to story 3”

Create a reaction to a story comment.

Create Task is used to create a new task in a Story.

Delete Category can be used to delete any Category.

Deletes a specific custom field from the Shortcut system using its unique public identifier. This endpoint should be used when you need to permanently remove a custom field that is no longer required in your workflows or project structure. It's important to note that this operation is irreversible, and once a custom field is deleted, all data associated with it will be lost. Use this endpoint with caution, ensuring that the custom field is no longer needed and that its deletion won't negatively impact any existing processes or data integrity within your Shortcut instance.

Permanently deletes a Doc and its associated data from Shortcut. Requires admin access to the document. When a document is deleted, connected clients will be notified via Server-Sent Events (SSE). Use this action when you need to remove a document completely from the system. Be cautious as this operation is irreversible.

Deletes a specific entity template from the Shortcut API. This endpoint should be used when you need to permanently remove a template that is no longer needed or is obsolete. It's important to note that this operation cannot be undone, so it should be used with caution. The deletion is performed on a single template identified by its public ID, adhering to the best practice of controlling deletion on a per-resource basis. This endpoint is part of the API v3, which may include enhanced features or changes compared to previous versions.

Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.

This endpoint allows you to delete a Comment from an Epic.

Delete File deletes a previously uploaded file.

Tool to delete a generic webhook integration from Shortcut. Use when you need to permanently remove a webhook integration that is no longer needed.

Deletes a specific iteration from the Shortcut project management system. This endpoint should be used when you need to permanently remove an iteration and all its associated data from your project workflow. It's particularly useful for cleaning up completed or cancelled iterations that are no longer needed. Be cautious when using this endpoint, as the deletion is irreversible and will remove all data associated with the specified iteration. Ensure you have the correct iteration ID before proceeding with the deletion to avoid unintended data loss.

Delete Label can be used to delete any Label.

Delete Linked File can be used to delete any previously attached Linked-File.

(Deprecated: Use 'Delete Objective') Delete Milestone can be used to delete any Milestone.

Delete Multiple Stories allows you to delete multiple archived stories at once.

Delete Objective can be used to delete any Objective.

Delete Project can be used to delete a Project. Projects can only be deleted if all associated Stories are moved or deleted. In the case that the Project cannot be deleted, you will receive a 422 response.

Delete Story can be used to delete any Story.

Delete a Comment from any story.

Removes the relationship between the stories for the given Story Link.

Delete a reaction from any story comment.

Delete Task can be used to delete any previously created Task on a Story.

Disables Iterations for the current workspace

Disables the Story Template feature for the Workspace.

Enables Iterations for the current workspace

Enables the Story Template feature for the Workspace.

Get Category returns information about the selected Category.

Returns information about the authenticated member.

Retrieves detailed information about a specific custom field in Shortcut using its unique public identifier. This endpoint allows developers to fetch the properties and configuration of a custom field, which can include its name, type, possible values, and any other associated metadata. It's particularly useful when you need to inspect or validate a custom field's settings programmatically, or when integrating custom field data into external systems. The endpoint should be used when detailed information about a single custom field is required, rather than for bulk operations or listing all custom fields. Note that this endpoint only provides read access to custom field data and cannot be used to modify the custom field.

Get Doc returns information about a chosen Doc by its public ID. Use content_format=html to include HTML content in the response.

Get Entity Template returns information about a given entity template.

Get Epic returns information about the selected Epic.

This endpoint returns information about the selected Epic Comment.

Get the current health status for the specified Epic. Use when you need to check the health status of an Epic.

Returns the Epic Workflow for the Workspace.

Get Stories which have a given External Link associated with them.

Get File returns information about the selected UploadedFile.

Get Generic Integration returns information about a webhook integration by its ID. Use when you need to retrieve details about a specific webhook integration.

Retrieves detailed information about a specific group in the Shortcut workspace using its unique public identifier. This endpoint allows developers to fetch comprehensive data about a group, including its name, type, and associated metadata. It's particularly useful when you need to access or verify group details programmatically, such as during workflow automations or when building integrations that involve group management. The endpoint provides more granular control and information compared to what's available through the web application, making it valuable for advanced group-related operations and data analysis within your Shortcut projects.

Retrieves detailed information about a specific iteration in the Shortcut project management system. This endpoint allows users to fetch comprehensive data about a single iteration, including its name, status, start and end dates, associated stories, and progress metrics. It should be used when detailed information about a particular iteration is needed, such as during sprint planning, progress tracking, or retrospective analysis. The endpoint provides a snapshot of the iteration at the time of the request and does not include real-time updates. It's particularly useful for project managers, scrum masters, and team members who need to review or report on iteration-specific data. Note that this endpoint only retrieves information and does not allow for modification of the iteration details.