Skip to main content
Shortcut
Shortcut
92 actions · 1 auth method
Ticketing

Authentication

API Key

Generate an API token from your Shortcut account settings to authenticate API requests.Guides: Connector Profile, Link Account
Actions
|
92 actions
Action
Description
Required scopes
List Categories
List all categories in the workspace
Get Category
Retrieve a specific category by its public ID
Create Category
Create a new category in Shortcut
Update Category
Update an existing category in Shortcut
Delete Category
Delete a category from Shortcut
List Custom Fields
List all custom fields in the workspace
Get Custom Field
Retrieve a specific custom field by its public ID
Update Custom Field
Update the definition of an existing custom field
Delete Custom Field
Delete a custom field from the workspace
List Docs
List all Docs in the Shortcut workspace
Get Doc
Retrieve a specific Doc by its public ID
Create Doc
Create a new Doc in Shortcut
Update Doc
Update an existing Doc in Shortcut
Delete Doc
Delete a Doc from Shortcut
List Epic Comments
List all comments on an epic
Get Epic Comment
Retrieve a specific comment on an epic
Create Epic Comment
Create a new comment on an epic
Delete Epic Comment
Delete a comment from an epic
List Epics
List all epics in the Shortcut workspace
Get Epic
Retrieve a specific epic by its public ID
Create Epic
Create a new epic in Shortcut
Update Epic
Update an existing epic in Shortcut
Delete Epic
Delete an epic from Shortcut
List Epic Stories
List all stories belonging to an epic
Get Epic Health
Retrieve the current health status of an epic
Create Epic Health
Create a new health status for an epic
Get Epic Workflow
Retrieve the epic workflow and its states
List Files
List all uploaded files in the workspace
Upload File
Upload a file to the workspace and optionally attach it to a story
Get File
Retrieve a specific uploaded file by its public ID
Delete File
Delete a previously uploaded file
List Groups
List all groups in the Shortcut workspace
Get Group
Retrieve a specific group by its public ID
Create Group
Create a new group in Shortcut
Update Group
Update an existing group in Shortcut
List Group Stories
List all stories associated with a specific group
List Iterations
List all iterations in the Shortcut workspace
Get Iteration
Retrieve a specific iteration by its public ID
Create Iteration
Create a new iteration in Shortcut
Update Iteration
Update an existing iteration in Shortcut
Delete Iteration
Delete an iteration from Shortcut
List Iteration Stories
List all stories in a specific iteration
Get Key Result
Retrieve a specific objective key result by its public ID
Update Key Result
Update an objective key result’s name or values
List Labels
List all labels in the Shortcut workspace
Get Label
Retrieve a specific label by its public ID
Create Label
Create a new label in Shortcut
Update Label
Update an existing label in Shortcut
Delete Label
Delete a label from Shortcut
List Members
List all members in the Shortcut workspace
Get Member
Retrieve a specific member by their public ID
Get Current Member
Retrieve the currently authenticated member
List Objectives
List all objectives in the workspace
Get Objective
Retrieve a specific objective by its public ID
Create Objective
Create a new objective in Shortcut
Update Objective
Update an existing objective in Shortcut
Delete Objective
Delete an objective from Shortcut
List Projects
List all projects in the Shortcut workspace
Get Project
Retrieve a specific project by its public ID
Create Project
Create a new project in Shortcut
Update Project
Update an existing project in Shortcut
Delete Project
Delete a project from Shortcut
List Project Stories
List all stories associated with a specific project
List Repositories
List all VCS repositories linked to the workspace
Search
Unified cross-entity search across epics, stories, iterations, objectives, and milestones
Search Stories
Search Shortcut stories via the /search/stories endpoint. Returns only story entities matching the query.
Search Epics
Search Shortcut epics via the /search/epics endpoint. Returns only epic entities matching the query.
Create Story
Create a new story in Shortcut
Get Story
Retrieve a specific story by its public ID
Update Story
Update an existing story in Shortcut
Delete Story
Delete a story from Shortcut
List Story Templates
List all story templates in the workspace
Create Story From Template
Create a new story derived from a story template
Query Stories
Search for stories using filter criteria
Get Story History
Retrieve the history of changes for a story
List Story Sub Tasks
List all sub-task stories for a given story
Create Multiple Stories
Create multiple stories in a single bulk request
List Story Comments
List all comments on a story
Get Story Comment
Retrieve a specific comment on a story
Create Story Comment
Add a new comment to a story
Update Story Comment
Update an existing comment on a story
Delete Story Comment
Delete a comment from a story
Create Story Link
Create a relationship between two stories
Get Story Link
Retrieve a specific story link
Update Story Link
Update an existing story link
Delete Story Link
Delete a story link
Create Story Task
Add a new task to a story
Get Story Task
Retrieve a specific task on a story
Update Story Task
Update an existing task on a story
Delete Story Task
Delete a task from a story
List Workflows
List all workflows in the Shortcut workspace
Get Workflow
Retrieve a specific workflow by its public ID

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/shortcut/filled/png

Connector Profile

Shortcut - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/shortcut/filled/png

Link Account

Shortcut - API Key
4

Use Actions

Invoke actions using one of the methods below: