> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Shortcut

> How to set up the Shortcut connector, plus the actions and events that are available.

![Shortcut](https://stackone-logos.com/api/shortcut/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/shortcut_pm/changelog.md)

[92 actions](#actions) · [6 events](#events) · 1 auth method

Project Management

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/shortcut_pm/guides/connector-profile/api-key.md)
>
> Generate an API token from your Shortcut account settings to authenticate API requests.

Optionally, configure receiving Events for Shortcut into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/shortcut_pm/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/shortcut_pm/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

read

write

No scopes found

92 actions

ActionDescriptionRequired scopes

List Categories`shortcut_pm_list_categories`

List all categories in the workspace

`read`

Get Category`shortcut_pm_get_category`

Retrieve a specific category by its public ID

`read`

Create Category`shortcut_pm_create_category`

Create a new category in Shortcut

`write`

Update Category`shortcut_pm_update_category`

Update an existing category in Shortcut

`write`

Delete Category`shortcut_pm_delete_category`

Delete a category from Shortcut

`write`

List Custom Fields`shortcut_pm_list_custom_fields`

List all custom fields in the workspace

`read`

Get Custom Field`shortcut_pm_get_custom_field`

Retrieve a specific custom field by its public ID

`read`

Update Custom Field`shortcut_pm_update_custom_field`

Update the definition of an existing custom field

`write`

Delete Custom Field`shortcut_pm_delete_custom_field`

Delete a custom field from the workspace

`write`

List Docs`shortcut_pm_list_docs`

List all Docs in the Shortcut workspace

`read`

Get Doc`shortcut_pm_get_doc`

Retrieve a specific Doc by its public ID

`read`

Create Doc`shortcut_pm_create_doc`

Create a new Doc in Shortcut

`write`

Update Doc`shortcut_pm_update_doc`

Update an existing Doc in Shortcut

`write`

Delete Doc`shortcut_pm_delete_doc`

Delete a Doc from Shortcut

`write`

List Epic Comments`shortcut_pm_list_epic_comments`

List all comments on an epic

`read`

Get Epic Comment`shortcut_pm_get_epic_comment`

Retrieve a specific comment on an epic

`read`

Create Epic Comment`shortcut_pm_create_epic_comment`

Create a new comment on an epic

`write`

Delete Epic Comment`shortcut_pm_delete_epic_comment`

Delete a comment from an epic

`write`

List Epics`shortcut_pm_list_epics`

List all epics in the Shortcut workspace

`read`

Get Epic`shortcut_pm_get_epic`

Retrieve a specific epic by its public ID

`read`

Create Epic`shortcut_pm_create_epic`

Create a new epic in Shortcut

`write`

Update Epic`shortcut_pm_update_epic`

Update an existing epic in Shortcut

`write`

Delete Epic`shortcut_pm_delete_epic`

Delete an epic from Shortcut

`write`

List Epic Stories`shortcut_pm_list_epic_stories`

List all stories belonging to an epic

`read`

Get Epic Health`shortcut_pm_get_epic_health`

Retrieve the current health status of an epic

`read`

Create Epic Health`shortcut_pm_create_epic_health`

Create a new health status for an epic

`write`

Get Epic Workflow`shortcut_pm_get_epic_workflow`

Retrieve the epic workflow and its states

`read`

List Files`shortcut_pm_list_files`

List all uploaded files in the workspace

`read`

Upload File`shortcut_pm_upload_file`

Upload a file to the workspace and optionally attach it to a story

`write`

Get File`shortcut_pm_get_file`

Retrieve a specific uploaded file by its public ID

`read`

Delete File`shortcut_pm_delete_file`

Delete a previously uploaded file

`write`

List Groups`shortcut_pm_list_groups`

List all groups in the Shortcut workspace

`read`

Get Group`shortcut_pm_get_group`

Retrieve a specific group by its public ID

`read`

Create Group`shortcut_pm_create_group`

Create a new group in Shortcut

`write`

Update Group`shortcut_pm_update_group`

Update an existing group in Shortcut

`write`

List Group Stories`shortcut_pm_list_group_stories`

List all stories associated with a specific group

`read`

List Iterations`shortcut_pm_list_iterations`

List all iterations in the Shortcut workspace

`read`

Get Iteration`shortcut_pm_get_iteration`

Retrieve a specific iteration by its public ID

`read`

Create Iteration`shortcut_pm_create_iteration`

Create a new iteration in Shortcut

`write`

Update Iteration`shortcut_pm_update_iteration`

Update an existing iteration in Shortcut

`write`

Delete Iteration`shortcut_pm_delete_iteration`

Delete an iteration from Shortcut

`write`

List Iteration Stories`shortcut_pm_list_iteration_stories`

List all stories in a specific iteration

`read`

Get Key Result`shortcut_pm_get_key_result`

Retrieve a specific objective key result by its public ID

`read`

Update Key Result`shortcut_pm_update_key_result`

Update an objective key result's name or values

`write`

List Labels`shortcut_pm_list_labels`

List all labels in the Shortcut workspace

`read`

Get Label`shortcut_pm_get_label`

Retrieve a specific label by its public ID

`read`

Create Label`shortcut_pm_create_label`

Create a new label in Shortcut

`write`

Update Label`shortcut_pm_update_label`

Update an existing label in Shortcut

`write`

Delete Label`shortcut_pm_delete_label`

Delete a label from Shortcut

`write`

List Members`shortcut_pm_list_members`

List all members in the Shortcut workspace

`read`

Get Member`shortcut_pm_get_member`

Retrieve a specific member by their public ID

`read`

Get Current Member`shortcut_pm_get_current_member`

Retrieve the currently authenticated member

`read`

List Objectives`shortcut_pm_list_objectives`

List all objectives in the workspace

`read`

Get Objective`shortcut_pm_get_objective`

Retrieve a specific objective by its public ID

`read`

Create Objective`shortcut_pm_create_objective`

Create a new objective in Shortcut

`write`

Update Objective`shortcut_pm_update_objective`

Update an existing objective in Shortcut

`write`

Delete Objective`shortcut_pm_delete_objective`

Delete an objective from Shortcut

`write`

List Projects`shortcut_pm_list_projects`

List all projects in the Shortcut workspace

`read`

Get Project`shortcut_pm_get_project`

Retrieve a specific project by its public ID

`read`

Create Project`shortcut_pm_create_project`

Create a new project in Shortcut

`write`

Update Project`shortcut_pm_update_project`

Update an existing project in Shortcut

`write`

Delete Project`shortcut_pm_delete_project`

Delete a project from Shortcut

`write`

List Project Stories`shortcut_pm_list_project_stories`

List all stories associated with a specific project

`read`

List Repositories`shortcut_pm_list_repositories`

List all VCS repositories linked to the workspace

`read`

Search`shortcut_pm_search`

Unified cross-entity search across epics, stories, iterations, objectives, and milestones

`read`

Search Stories`shortcut_pm_search_stories`

Search Shortcut stories via the /search/stories endpoint. Returns only story entities matching the query.

`read`

Search Epics`shortcut_pm_search_epics`

Search Shortcut epics via the /search/epics endpoint. Returns only epic entities matching the query.

`read`

Create Story`shortcut_pm_create_story`

Create a new story in Shortcut

`write`

Get Story`shortcut_pm_get_story`

Retrieve a specific story by its public ID

`read`

Update Story`shortcut_pm_update_story`

Update an existing story in Shortcut

`write`

Delete Story`shortcut_pm_delete_story`

Delete a story from Shortcut

`write`

List Story Templates`shortcut_pm_list_story_templates`

List all story templates in the workspace

`read`

Create Story From Template`shortcut_pm_create_story_from_template`

Create a new story derived from a story template

`write`

Query Stories`shortcut_pm_query_stories`

Search for stories using filter criteria

`read`

Get Story History`shortcut_pm_get_story_history`

Retrieve the history of changes for a story

`read`

List Story Sub Tasks`shortcut_pm_list_story_sub_tasks`

List all sub-task stories for a given story

`read`

Create Multiple Stories`shortcut_pm_create_multiple_stories`

Create multiple stories in a single bulk request

`write`

List Story Comments`shortcut_pm_list_story_comments`

List all comments on a story

`read`

Get Story Comment`shortcut_pm_get_story_comment`

Retrieve a specific comment on a story

`read`

Create Story Comment`shortcut_pm_create_story_comment`

Add a new comment to a story

`write`

Update Story Comment`shortcut_pm_update_story_comment`

Update an existing comment on a story

`write`

Delete Story Comment`shortcut_pm_delete_story_comment`

Delete a comment from a story

`write`

Create Story Link`shortcut_pm_create_story_link`

Create a relationship between two stories

`write`

Get Story Link`shortcut_pm_get_story_link`

Retrieve a specific story link

`read`

Update Story Link`shortcut_pm_update_story_link`

Update an existing story link

`write`

Delete Story Link`shortcut_pm_delete_story_link`

Delete a story link

`write`

Create Story Task`shortcut_pm_create_story_task`

Add a new task to a story

`write`

Get Story Task`shortcut_pm_get_story_task`

Retrieve a specific task on a story

`read`

Update Story Task`shortcut_pm_update_story_task`

Update an existing task on a story

`write`

Delete Story Task`shortcut_pm_delete_story_task`

Delete a task from a story

`write`

List Workflows`shortcut_pm_list_workflows`

List all workflows in the Shortcut workspace

`read`

Get Workflow`shortcut_pm_get_workflow`

Retrieve a specific workflow by its public ID

`read`

## Events

Tags

Select all
|
Clear

Comments

Epics

Stories

Tasks

Webhooks

No tags found

6 events

EventDescriptionTags

Story Events`shortcut_pm_webhook_story`

Fired when a story is created, updated (including workflow-state moves), or deleted in the Shortcut workspace.

StoriesWebhooks

Epic Events`shortcut_pm_webhook_epic`

Fired when an epic is created, updated, or deleted in the Shortcut workspace.

EpicsWebhooks

Story Comment Events`shortcut_pm_webhook_story_comment`

Fired when a comment is added to, edited on, or deleted from a story.

StoriesCommentsWebhooks

Story Task Events`shortcut_pm_webhook_story_task`

Fired when a task (checklist item) is added to, edited on, or deleted from a story.

StoriesTasksWebhooks

Other Events`shortcut_pm_webhook_other`

Fired for any Shortcut webhook delivery whose primary action entity type has no dedicated handler (anything other than s...

Webhooks

Epic Comment Events`shortcut_pm_webhook_epic_comment`

Fired when a comment is added to, edited on, or deleted from an epic.

EpicsCommentsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.