Team
Shared credential for production and unattended runs.
Connect Shortcut with Hookshot™ and your stack
Shortcut aligns product development work with company objectives so teams can execute with a shared purpose.
Tools and triggers
What Agents can do in Shortcut
Available tools and events after Shortcut is connected.
-
Create Category
Create Category allows you to create a new Category in Shortcut.
-
Create Doc
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 Entity Template
Create a new entity template for the Workspace.
-
Create Epic
Create Epic allows you to create a new Epic in Shortcut.
-
Create Epic Comment
This endpoint allows you to create a threaded Comment on an Epic.
-
Create Epic Comment Comment
This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
-
Create Epic Health
Create a new health status for the specified Epic. Use when you need to set or update the health tracking status of an Epic.
-
Create Generic Integration
Tool to create a generic webhook integration in Shortcut. Use when you need to set up a webhook endpoint to receive Shortcut events.
-
Create Group
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…
-
Create Iteration
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…
-
Create Label
Create Label allows you to create a new Label in Shortcut.
-
Create Linked File
Create Linked File allows you to create a new Linked File in Shortcut.
-
Create Multiple Stories
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
Create Objective allows you to create a new Objective in Shortcut.
-
Create Project
Create Project is used to create a new Shortcut Project.
-
Create Story
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…
-
Create Story Comment
Create Comment allows you to create a Comment on any Story.
-
Create Story From Template
Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.
-
Create Story Link
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…
-
Create Story Reaction
Create a reaction to a story comment.
-
Create Task
Create Task is used to create a new task in a Story.
-
Delete Category
Delete Category can be used to delete any Category.
-
Delete Custom Field
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…
-
Delete Doc
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…
-
Delete Entity Template
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…
-
Delete Epic
Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
-
Delete Epic Comment
This endpoint allows you to delete a Comment from an Epic.
-
Delete File
Delete File deletes a previously uploaded file.
-
Delete Generic Integration
Tool to delete a generic webhook integration from Shortcut. Use when you need to permanently remove a webhook integration that is no longer needed.
-
Delete Iteration
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…
-
Delete Label
Delete Label can be used to delete any Label.
-
Delete Linked File
Delete Linked File can be used to delete any previously attached Linked-File.
-
Delete Multiple Stories
Delete Multiple Stories allows you to delete multiple archived stories at once.
-
Delete Objective
Delete Objective can be used to delete any Objective.
-
Delete Project
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
Delete Story can be used to delete any Story.
-
Delete Story Comment
Delete a Comment from any story.
-
Delete Story Link
Removes the relationship between the stories for the given Story Link.
-
Delete Story Reaction
Delete a reaction from any story comment.
-
Delete Task
Delete Task can be used to delete any previously created Task on a Story.
-
Disable Iterations
Disables Iterations for the current workspace
-
Disable Story Templates
Disables the Story Template feature for the Workspace.
-
Enable Iterations
Enables Iterations for the current workspace
-
Enable Story Templates
Enables the Story Template feature for the Workspace.
-
Get Category
Get Category returns information about the selected Category.
-
Get Current Member Info
Returns information about the authenticated member.
-
Get Custom Field
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…
-
Get Doc
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
Get Entity Template returns information about a given entity template.
-
Get Epic
Get Epic returns information about the selected Epic.
-
Get Epic Comment
This endpoint returns information about the selected Epic Comment.
-
Get Epic Health
Get the current health status for the specified Epic. Use when you need to check the health status of an Epic.
-
Get Epic Workflow
Returns the Epic Workflow for the Workspace.
-
Get External Link Stories
Get Stories which have a given External Link associated with them.
-
Get File
Get File returns information about the selected UploadedFile.
-
Get Generic Integration
Get Generic Integration returns information about a webhook integration by its ID. Use when you need to retrieve details about a specific webhook integration.
-
Get Group
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…
-
Get Iteration
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…
-
Get Key Result
Get Key Result returns information about a chosen Key Result.
-
Get Label
Get Label returns information about the selected Label.
-
Get Linked File
Get File returns information about the selected Linked File.
-
Get Member
Returns information about a Member.
-
Get Objective
Get Objective returns information about a chosen Objective.
-
Get Project
Get Project returns information about the selected Project.
-
Get Repository
Get Repository returns information about the selected Repository.
-
Get Story
Get Story returns information about a chosen Story.
-
Get Story Comment
Get Comment is used to get Comment information.
-
Get Story Link
Returns the stories and their relationship for the given Story Link.
-
Get Task
Returns information about a chosen Task.
-
Get Workflow
Get Workflow returns information about a chosen Workflow.
-
Link Document to Epic
Tool to create a relationship between a Document and an Epic. Use when you need to link or associate documentation with an epic.
-
List Categories
List Categories returns a list of all Categories and their attributes.
-
List Category Milestones
List Category Milestones returns a list of all Milestones with the Category.
-
List Category Objectives
Returns a list of all Objectives with the Category.
-
List Custom Fields
Retrieves a list of all custom fields defined in the Shortcut API. This endpoint allows developers to fetch information about user-defined fields that have been added to extend the functionality of standard fields in…
-
List Docs
Tool to list Docs that the current user can read. Use when you need to retrieve all accessible documentation in the Shortcut workspace.
-
List Document Epics
Tool to retrieve all Epics related to a specific Document. Use when you need to understand which Epics are associated with a given document in Shortcut.
-
List Entity Templates
List all the entity templates for the Workspace.
-
List Epic Comments
Get a list of all Comments on an Epic.
-
List Epic Documents
Get a list of all Documents related to this Epic.
-
List Epic Healths
List the history of health statuses for the specified Epic, most recent first. Use when you need to track health status changes over time.
-
List Epic Stories
Get a list of all Stories in an Epic.
-
List Epics
List Epics returns a list of all Epics and their attributes.
-
List Epics Paginated
List Epics with pagination returns a paginated list of Epics and their attributes. Use when you need to retrieve Epics in manageable pages rather than all at once.
-
List Files
List Files returns a list of all UploadedFiles in the workspace.
-
List Group Stories
List the Stories assigned to the Group. (By default, limited to 1,000).
-
List Groups
A group in our API maps to a "Team" within the Shortcut Product. A Team is a collection of Users that can be associated to Stories, Epics, and Iterations within Shortcut.
-
List Iteration Stories
Get a list of all Stories in an Iteration.
-
List Iterations
Retrieves a list of all iterations in the Shortcut project management system. Iterations represent specific time periods for planning and tracking work, allowing teams to organize their development cycles. This…
-
List Label Epics
List all of the Epics with the Label.
-
List Label Stories
List all of the Stories with the Label.
-
List Labels
List Labels returns a list of all Labels and their attributes.
-
List Linked Files
List Linked Files returns a list of all Linked-Files and their attributes.
-
List Members
Returns information about members of the Workspace.
-
List Members (slim)
Returns minimal member data optimized for Korey integration. Use this when you need basic member information without full profile details. Returns all workspace members with disabled status indicated in the response.
-
List Objective Epics
List all of the Epics within the Objective.
-
List Objectives
List Objectives returns a list of all Objectives and their attributes.
-
List Projects
List Projects returns a list of all Projects and their attributes.
-
List Repositories
List Repositories returns a list of all Repositories and their attributes.
-
List Stories
List Stories returns a list of all Stories in a selected Project and their attributes.
-
List Story Comment
Lists Comments associated with a Story
-
List Story Sub-Tasks
Tool to list all Sub-task Stories for a given parent Story. Use when you need to retrieve all sub-tasks associated with a specific story.
-
List Workflows
Returns a list of all Workflows in the Workspace.
-
Search
Search lets you search Epics and Stories based on desired parameters. Since ordering of the results can change over time (due to search ranking decay, new Epics and Stories being created), the `next` value from the…
-
Search Documents
Tool to search Documents based on title and filters. Use when you need to find specific documents by fuzzy title matching or filter by archived/created_by_me/followed_by_me status.
-
Search Epics
Search Epics lets you search Epics based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new Epics being created), the `next` value from the previous response can be…
-
Search Iterations
Search Iterations lets you search Iterations based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Iterations being created), the `next` value from the previous…
-
Search Milestones
Search Milestones lets you search Milestones based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Milestones being created), the `next` value from the previous…
-
Search Objectives
Search Objectives lets you search Objectives based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Objectives being created), the `next` value from the previous…
-
Search Stories
Search Stories lets you search Stories based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new stories being created), the `next` value from the previous response…
-
Search Stories Old
Search Stories lets you search Stories based on desired parameters.
-
Story History
Retrieves the complete history of changes for a specific story in the Shortcut project management system. This endpoint allows users to track all modifications, updates, and revisions made to a story over time…
-
Unlink Comment Thread From Slack
Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)
-
Unlink Document From Epic
Tool to remove the relationship between a Document and an Epic. Use when you need to unlink a previously associated document from an epic.
-
Unlink Productboard From Epic
This endpoint allows you to unlink a productboard epic.
-
Update Category
Update Category allows you to replace a Category name with another name. If you try to name a Category something that already exists, you will receive a 422 response.
-
Update Custom Field
Update Custom Field can be used to update the definition of a Custom Field. The order of items in the 'values' collection is interpreted to be their ascending sort order.To delete an existing enum value, simply omit it…
-
Update Doc
Tool to update an existing Doc's title and/or content. Use when you need to modify document properties. Supports markdown or HTML input via content_format parameter. SSE events notify connected users to refresh; if no…
-
Update Entity Template
Update an entity template's name or its contents.
-
Update Epic
Update Epic can be used to update numerous fields in the Epic. The only required parameter is Epic ID, which can be found in the Shortcut UI.
-
Update Epic Comment
This endpoint allows you to update a threaded Comment on an Epic.
-
Update File
Update File updates the properties of an UploadedFile (but not its content).
-
Update Group
Updates an existing group in the Shortcut workspace. This endpoint allows you to modify various properties of a group, including its name, description, color, members, and associated workflows. Use this when you need…
-
Update Health Status
Update an existing health status by its ID. Use when you need to modify the health tracking status of an Epic or Objective.
-
Update Iteration
This endpoint allows you to update an existing iteration in Shortcut. It provides comprehensive control over various aspects of an iteration, including its metadata, associated members and groups, labels, and…
-
Update Key Result
Update Key Result allows updating a Key Result's name or initial, observed, or target values.
-
Update Label
Update Label allows you to replace a Label name with another name. If you try to name a Label something that already exists, you will receive a 422 response.
-
Update Linked File
Updated Linked File allows you to update properties of a previously attached Linked-File.
-
Update Multiple Stories
Update Multiple Stories allows you to make changes to numerous stories at once.
-
Update Objective
Update Objective can be used to update Objective properties.
-
Update Project
Update Project can be used to change properties of a Project.
-
Update Story
Update Story can be used to update Story properties.
-
Update Story Comment
Update Comment replaces the text of the existing Comment.
-
Update Story Link
Updates the stories and/or the relationship for the given Story Link.
-
Update Task
Update Task can be used to update Task properties.
-
Upload Files
Upload Files uploads one or many files and optionally associates them with a story. Use the multipart/form-data content-type to upload. Each `file` key should contain a separate file. Each UploadedFile's name comes…
Setup
Connect Shortcut in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
