Shortcut

These are the Shortcut actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• 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.

• 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 project

  Get Project returns information about the selected Project.

• List categories

  List Categories returns a list of all Categories and their attributes.

• 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 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 milestones

  (Deprecated: Use 'List Objectives') List Milestones returns a list of all Milestones and their attributes.

• List objectives

  List Objectives returns a list of all Objectives and their attributes.

• 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 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 response can be used as the path and query string for the next page to ensure stable ordering.

• Create category

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

• 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 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.

• 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 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

  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 milestone

  (Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone 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.

• 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. 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 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 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 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 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.

• 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 you need to remove a document completely from the system. Be cautious as this operation is irreversible.

• 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 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

  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 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

  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 milestone

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

• 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 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 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, 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.

• 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 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.

• 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 milestone

  (Deprecated: Use 'Get Objective') Get Milestone returns information about a chosen Milestone.

• Get objective

  Get Objective returns information about a chosen Objective.

• 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 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 integrations. It's particularly useful when you need to understand the structure and types of custom data being used across the system. The endpoint returns details about each custom field, which may include their identifiers, names, types, and any associated metadata. Use this endpoint when you need to inventory existing custom fields, prepare for data migrations, or dynamically adjust your application's data model to accommodate custom fields. Note that this endpoint does not create, modify, or delete custom fields; it's purely for retrieval of existing custom field definitions.

• 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 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 endpoint provides comprehensive information about each iteration, including its name, start and end dates, status, and associated stories or tasks. Use this endpoint when you need an overview of all iterations for project planning, progress tracking, or reporting purposes. It's particularly useful for analyzing past performance, planning future sprints, or getting a high-level view of the project timeline. Note that the response may be paginated for projects with a large number of iterations, and you might need to make multiple requests to retrieve the full dataset.

• 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 milestone epics

  (Deprecated: Use 'List Objective Epics') List all of the Epics within the Milestone.

• List objective epics

  List all of the Epics within the Objective.

• 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 previous response can be used as the path and query string for the next page to ensure stable ordering.

• 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 used as the path and query string for the next page to ensure stable ordering.

• 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 response can be used as the path and query string for the next page to ensure stable ordering.

• 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 response can be used as the path and query string for the next page to ensure stable ordering.

• 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 can be used as the path and query string for the next page to ensure stable ordering.

• 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, providing a comprehensive timeline of its evolution. It's particularly useful for project managers, team members, and stakeholders who need to understand how a story has changed, who made the changes, and when they occurred. The endpoint returns a chronological list of all events and modifications associated with the specified story, helping teams maintain transparency and accountability in their project workflows. Note that this endpoint focuses solely on the history of a single story and does not provide information about related stories or overall project status.

• 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 from the 'values' collection. New enum values may be created inline by including an object in the 'values' collection having a 'value' entry with no 'id' (eg. {'value': 'myNewValue', 'color_key': 'green'}).

• 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 users are connected, CKEditor cache is flushed.

• 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 to change group details, add or remove members, or update the group's visual representation. It's particularly useful for team reorganizations, project changes, or general maintenance of your Shortcut workspace structure. Note that while many fields are optional, you should include any fields you wish to modify; omitted fields will retain their current values.

• 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 timeframe. Use this endpoint when you need to modify any details of an ongoing or upcoming iteration, such as adjusting dates, adding followers, or updating labels. The endpoint is particularly useful for project managers or team leads who need to refine iteration details as the project progresses. Note that while you can update multiple aspects of an iteration in a single call, only the fields you include in the request will be modified; omitted fields will retain their current values.

• 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 milestone

  (Deprecated: Use 'Update Objective') Update Milestone can be used to update Milestone properties.

• 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 from the Content-Disposition header "filename" directive for that field.