# Shortcut integration

> Project management for software teams: stories, epics, iterations, objectives, labels, docs, and workflows via the Shortcut REST API v3.

- Authentication: apiKey

## Tools (135)

- **Create Category**: Create Category allows you to create a new Category in Shortcut.
- **Create Doc**: Creates a new Doc. Supports markdown or HTML input via content_format parameter.
- **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.
- **Create Generic Integration**: Create a generic webhook integration that Shortcut posts workspace events to.
- **Create Group**: Create a Group (a Team in the Shortcut product).
- **Create Iteration**: Create a new Iteration.
- **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 in a single request using the same syntax as Create Story.
- **Create Objective**: Create Objective allows you to create a new Objective in Shortcut.
- **Create Objective Health**: Create a new health status for the specified Objective.
- **Create Project**: Create Project is used to create a new Shortcut Project.
- **Create Story**: Create Story adds a new story to the Workspace. Requires either workflow_state_id or project_id (exactly one); workflow_state_id is recommended.
- **Create Story Comment**: Create Comment allows you to create a Comment on any Story.
- **Create Story From Template**: Create a new story derived from a story template. story_template_id is required; template values can be extended with the *_add / *_remove fields.
- **Create Story Link**: Create a Story Link (Story Relationship in the UI): subject story blocks, duplicates, or relates to object story.
- **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**: Delete a Custom Field.
- **Delete Doc**: Permanently deletes a Doc and its associated data. Requires admin access to the doc.
- **Delete Entity Template**: Delete an entity template.
- **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**: Delete a generic webhook integration.
- **Delete Iteration**: Delete an Iteration.
- **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.
- **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**: Get a Custom Field by ID.
- **Get Doc**: Get a Doc by its public ID with content.
- **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 for the specified 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 a generic webhook integration by ID.
- **Get Group**: Get a Group (Team) by ID.
- **Get Iteration**: Get an Iteration by ID.
- **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 Objective Health**: Get the current health for the specified 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**: Create a relationship between a Document and an Epic.
- **List Categories**: List Categories returns a list of all Categories and their attributes.
- **List Category Objectives**: Returns a list of all Objectives with the Category.
- **List Custom Fields**: List the Custom Fields defined in the workspace.
- **List Docs**: List Docs returns a list of Doc that the current user can read.
- **List Document Epics**: Get a list of all Epics related to this Document.
- **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.
- **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.
- **List Epic Stories**: Get a list of all Stories in an Epic.
- **List Files**: List Files returns a list of all UploadedFiles in the workspace.
- **List Groups**: List Groups. A group in the API maps to a Team within Shortcut: a collection of Users that can be associated to Stories, Epics, and Iterations.
- **List Group Stories**: List the Stories assigned to the Group. (By default, limited to 1,000).
- **List Iterations**: List all Iterations in the workspace.
- **List Iteration Stories**: Get a list of all Stories in an Iteration.
- **List Label Epics**: List all of the Epics with the Label.
- **List Labels**: List Labels returns a list of all Labels and their attributes.
- **List Label Stories**: List all of the Stories with the Label.
- **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 Objective Epics**: List all of the Epics within the Objective.
- **List Objective Healths**: List the history of health statuses for the specified Objective, most recent first.
- **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**: List Story Sub tasks returns a list of all Sub-task Stories for a given parent Story.
- **List Workflows**: Returns a list of all Workflows in the Workspace.
- **Query Stories**: Search Stories with structured filters in a POST body (owners, epics, workflow states, dates, labels).
- **Search**: Search Epics and Stories (and optionally Iterations and Objectives) with search operators. Returns a `next` path for stable pagination.
- **Search Documents**: Search Documents by title with structured filters: archived, created_by_me, followed_by_me.
- **Search Epics**: Search Epics with search operators. Returns a `next` path for stable pagination.
- **Search Iterations**: Search Iterations with search operators. Returns a `next` path for stable pagination.
- **Search Objectives**: Search Objectives with search operators. Returns a `next` path for stable pagination.
- **Search Stories**: Search Stories with search operators. Returns a `next` path for stable pagination.
- **Story History**: Get the change history of a Story.
- **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**: Remove a relationship between a Document and an 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.
- **Update Doc**: Updates an existing Doc's title and/or content. Supports markdown or HTML input via content_format parameter.
- **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**: Update a Group (Team).
- **Update Health**: Update an existing health status by its ID.
- **Update Iteration**: Update an Iteration.
- **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, including workflow state, owners, labels and position.
- **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. Uses multipart/form-data.

Connect Shortcut in General Input: https://www.generalinput.com/apps/shortcut