Get customers
Answer customers
Work for you
Reach people
Give agents tools
Run and ship
Stories, Epics, iterations and project management
Create Category allows you to create a new Category in Shortcut.
5 fields
Delete Category can be used to delete any Category.
1 field
Get Category returns information about the selected Category.
List Categories returns a list of all Categories and their attributes.
List Category Milestones returns a list of all Milestones with the Category.
Returns a list of all Objectives with the 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.
Creates a new Doc. Supports markdown or HTML input via content_format parameter. WARNING: if content_format is not supplied, `content` input defaults to html.
4 fields
Permanently deletes a Doc and its associated data. Requires admin access to the doc. When a document is deleted, connected clients will be notified via SSE events.
3 fields
Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
2 fields
Create a relationship between a Document and an Epic.
List Docs returns a list of Doc that the current user can read.
Get a list of all Epics related to this Document.
Remove a relationship between a Document and an Epic.
Updates an existing Doc's title and/or content. Supports markdown or HTML input via content_format parameter. WARNING: if content_format is not supplied, `content` input defaults to html. When a document is updated: (1) For Tiptap-migrated docs, SSE events notify connected Tiptap clients to refresh.
Create a new entity template for the Workspace.
Delete Entity Template using the Shortcut REST API.
Disables the Story Template feature for the Workspace.
Enables the Story Template feature for the Workspace.
Get Entity Template returns information about a given entity template.
List all the entity templates for the Workspace.
Update an entity template's name or its contents.
Create Epic allows you to create a new Epic in Shortcut.
16 fields
This endpoint allows you to create a threaded Comment on an Epic.
7 fields
This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
8 fields
Create a new health status for the specified Epic.
Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
This endpoint allows you to delete a Comment from an Epic.
Get Epic returns information about the selected Epic.
This endpoint returns information about the selected Epic Comment.
Get the current health for the specified Epic.
Get a list of all Comments on an Epic.
Get a list of all Documents related to this Epic.
List the history of health statuses for the specified Epic, most recent first.
Get a list of all Stories in an Epic.
List Epics returns a list of all Epics and their attributes.
List Epics with pagination returns a paginated list of Epics and their attributes.
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.
17 fields
This endpoint allows you to update a threaded Comment on an Epic.
Create Generic Integration using the Shortcut REST API.
Delete Generic Integration using the Shortcut REST API.
Get Generic Integration using the Shortcut REST API.
Create Group using the Shortcut REST API.
9 fields
Get Group using the Shortcut REST API.
List the Stories assigned to the Group. (By default, limited to 1,000).
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.
Update Group using the Shortcut REST API.
12 fields
Create Iteration using the Shortcut REST API.
Delete Iteration using the Shortcut REST API.
Disables Iterations for the current workspace
Enables Iterations for the current workspace
Get Iteration using the Shortcut REST API.
Get a list of all Stories in an Iteration.
List Iterations using the Shortcut REST API.
Update Iteration using the Shortcut REST API.
6 fields
Create Label allows you to create a new Label in Shortcut.
Delete Label can be used to delete any Label.
Get Label returns information about the selected Label.
List all of the Epics with the Label.
List all of the Stories with the Label.
List Labels returns a list of all Labels and their attributes.
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.
Create Linked File allows you to create a new Linked File in Shortcut.
10 fields
Delete Linked File can be used to delete any previously attached Linked-File.
Get File returns information about the selected Linked File.
List Linked Files returns a list of all Linked-Files and their attributes.
Updated Linked File allows you to update properties of a previously attached Linked-File.
(Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone in Shortcut.
(Deprecated: Use 'Delete Objective') Delete Milestone can be used to delete any Milestone.
(Deprecated: Use 'Get Objective') Get Milestone returns information about a chosen Milestone.
(Deprecated: Use 'List Objective Epics') List all of the Epics within the Milestone.
(Deprecated: Use 'List Objectives') List Milestones returns a list of all Milestones and their attributes.
(Deprecated: Use 'Update Objective') Update Milestone can be used to update Milestone properties.
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 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
22 fields
Create Comment allows you to create a Comment on any Story.
Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.
Create a reaction to a story comment.
Create Task is used to create a new task in a Story.
Delete Multiple Stories allows you to delete multiple archived stories at once.
Delete Story can be used to delete any Story.
Delete a Comment from any story.
Delete a reaction from any story comment.
Delete Task can be used to delete any previously created Task on a Story.
Get Story returns information about a chosen Story.
Get Comment is used to get Comment information.
Returns information about a chosen Task.
Lists Comments associated with a Story
List Story Sub tasks returns a list of all Sub-task Stories for a given parent Story.
Search Stories lets you search Stories based on desired parameters.
Story History using the Shortcut REST API.
Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)
Update Multiple Stories allows you to make changes to numerous stories at once.
14 fields
Update Story can be used to update Story properties.
20 fields
Update Comment replaces the text of the existing Comment.
Update Task can be used to update Task properties.
Create Objective allows you to create a new Objective in Shortcut.
Create a new health status for the specified Objective.
Delete Objective can be used to delete any Objective.
Get Objective returns information about a chosen Objective.
Get the current health for the specified Objective.
List all of the Epics within the Objective.
List the history of health statuses for the specified Objective, most recent first.
List Objectives returns a list of all Objectives and their attributes.
Update Objective can be used to update Objective properties.
Create Project is used to create a new Shortcut Project.
11 fields
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.
Get Project returns information about the selected Project.
List Projects returns a list of all Projects and their attributes.
List Stories returns a list of all Stories in a selected Project and their attributes.
Update Project can be used to change properties of a Project.
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 sentenc
Removes the relationship between the stories for the given Story Link.
Returns the stories and their relationship for the given Story Link.
Updates the stories and/or the relationship for the given Story Link.
Delete Custom Field using the Shortcut REST API.
Get Custom Field using the Shortcut REST API.
List Custom Fields using the Shortcut REST API.
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
Delete File deletes a previously uploaded file.
Get File returns information about the selected UploadedFile.
List Files returns a list of all UploadedFiles in the workspace.
Update File updates the properties of an UploadedFile (but not its content).
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.
Returns information about the authenticated member.
Returns the Epic Workflow for the Workspace.
Get Stories which have a given External Link associated with them.
Get Key Result returns information about a chosen Key Result.
Update Key Result allows updating a Key Result's name or initial, observed, or target values.
Returns information about a Member.
Returns information about members of the Workspace.
Get Repository returns information about the selected Repository.
List Repositories returns a list of all Repositories and their attributes.
Get Workflow returns information about a chosen Workflow.
Returns a list of all Workflows in the Workspace.
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 ensur
Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
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 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 stabl
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 stabl
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 stabl
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 orderin
Update an existing health status by its ID.
