Shortcut

Delete Category can be used to delete any Category. via DELETE /api/v3/categories/{category-public-id}

Delete Custom Field via DELETE /api/v3/custom-fields/{custom-field-public-id}

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. via DELETE /api/v3/documents/{doc-public-id}

Remove a relationship between a Document and an Epic. via DELETE /api/v3/documents/{doc-public-id}/epics/{epic-public-id}

Delete Entity Template via DELETE /api/v3/entity-templates/{entity-template-public-id}

Delete Epic can be used to delete the Epic. The only required parameter is Epic ID. via DELETE /api/v3/epics/{epic-public-id}

This endpoint allows you to delete a Comment from an Epic. via DELETE /api/v3/epics/{epic-public-id}/comments/{comment-public-id}

Delete File deletes a previously uploaded file. via DELETE /api/v3/files/{file-public-id}

Delete Generic Integration via DELETE /api/v3/integrations/webhook/{integration-public-id}

Delete Iteration via DELETE /api/v3/iterations/{iteration-public-id}

Delete Label can be used to delete any Label. via DELETE /api/v3/labels/{label-public-id}

Delete Linked File can be used to delete any previously attached Linked-File. via DELETE /api/v3/linked-files/{linked-file-public-id}

Delete Objective can be used to delete any Objective. via DELETE /api/v3/objectives/{objective-public-id}

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. via DELETE /api/v3/projects/{project-public-id}

Delete Multiple Stories allows you to delete multiple archived stories at once. via DELETE /api/v3/stories/bulk

Delete Story can be used to delete any Story. via DELETE /api/v3/stories/{story-public-id}

Delete a Comment from any story. via DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id}

Delete a reaction from any story comment. via DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions

Delete Task can be used to delete any previously created Task on a Story. via DELETE /api/v3/stories/{story-public-id}/tasks/{task-public-id}

Removes the relationship between the stories for the given Story Link. via DELETE /api/v3/story-links/{story-link-public-id}

List Categories returns a list of all Categories and their attributes. via GET /api/v3/categories

Get Category returns information about the selected Category. via GET /api/v3/categories/{category-public-id}

List Category Milestones returns a list of all Milestones with the Category. via GET /api/v3/categories/{category-public-id}/milestones

Returns a list of all Objectives with the Category. via GET /api/v3/categories/{category-public-id}/objectives

List Custom Fields via GET /api/v3/custom-fields

Get Custom Field via GET /api/v3/custom-fields/{custom-field-public-id}

List Docs returns a list of Doc that the current user can read. via GET /api/v3/documents

Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content. via GET /api/v3/documents/{doc-public-id}

Get a list of all Epics related to this Document. via GET /api/v3/documents/{doc-public-id}/epics

List all the entity templates for the Workspace. via GET /api/v3/entity-templates

Get Entity Template returns information about a given entity template. via GET /api/v3/entity-templates/{entity-template-public-id}

Returns the Epic Workflow for the Workspace. via GET /api/v3/epic-workflow

List Epics returns a list of all Epics and their attributes. via GET /api/v3/epics

Get Epic returns information about the selected Epic. via GET /api/v3/epics/{epic-public-id}

Get a list of all Comments on an Epic. via GET /api/v3/epics/{epic-public-id}/comments

This endpoint returns information about the selected Epic Comment. via GET /api/v3/epics/{epic-public-id}/comments/{comment-public-id}

Get a list of all Documents related to this Epic. via GET /api/v3/epics/{epic-public-id}/documents

Get the current health for the specified Epic. via GET /api/v3/epics/{epic-public-id}/health

List the history of health statuses for the specified Epic, most recent first. via GET /api/v3/epics/{epic-public-id}/health-history

Get a list of all Stories in an Epic. via GET /api/v3/epics/{epic-public-id}/stories

List Epics with pagination returns a paginated list of Epics and their attributes. via GET /api/v3/epics/paginated

Get Stories which have a given External Link associated with them. via GET /api/v3/external-link/stories

List Files returns a list of all UploadedFiles in the workspace. via GET /api/v3/files

Get File returns information about the selected UploadedFile. via GET /api/v3/files/{file-public-id}

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. via GET /api/v3/groups

Get Group via GET /api/v3/groups/{group-public-id}

List the Stories assigned to the Group. (By default, limited to 1,000). via GET /api/v3/groups/{group-public-id}/stories

Get Generic Integration via GET /api/v3/integrations/webhook/{integration-public-id}

List Iterations via GET /api/v3/iterations

Get Iteration via GET /api/v3/iterations/{iteration-public-id}

Get a list of all Stories in an Iteration. via GET /api/v3/iterations/{iteration-public-id}/stories

Get Key Result returns information about a chosen Key Result. via GET /api/v3/key-results/{key-result-public-id}

List Labels returns a list of all Labels and their attributes. via GET /api/v3/labels

Get Label returns information about the selected Label. via GET /api/v3/labels/{label-public-id}

List all of the Epics with the Label. via GET /api/v3/labels/{label-public-id}/epics

List all of the Stories with the Label. via GET /api/v3/labels/{label-public-id}/stories

List Linked Files returns a list of all Linked-Files and their attributes. via GET /api/v3/linked-files

Get File returns information about the selected Linked File. via GET /api/v3/linked-files/{linked-file-public-id}

Returns information about the authenticated member. via GET /api/v3/member

Returns information about members of the Workspace. via GET /api/v3/members

Returns information about a Member. via GET /api/v3/members/{member-public-id}

List Objectives returns a list of all Objectives and their attributes. via GET /api/v3/objectives

Get Objective returns information about a chosen Objective. via GET /api/v3/objectives/{objective-public-id}

List all of the Epics within the Objective. via GET /api/v3/objectives/{objective-public-id}/epics

Get the current health for the specified Objective. via GET /api/v3/objectives/{objective-public-id}/health

List the history of health statuses for the specified Objective, most recent first. via GET /api/v3/objectives/{objective-public-id}/health-history

List Projects returns a list of all Projects and their attributes. via GET /api/v3/projects

Get Project returns information about the selected Project. via GET /api/v3/projects/{project-public-id}

List Stories returns a list of all Stories in a selected Project and their attributes. via GET /api/v3/projects/{project-public-id}/stories

List Repositories returns a list of all Repositories and their attributes. via GET /api/v3/repositories

Get Repository returns information about the selected Repository. via GET /api/v3/repositories/{repo-public-id}

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. via GET /api/v3/search

Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me. via GET /api/v3/search/documents

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. via GET /api/v3/search/epics

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. via GET /api/v3/search/iterations

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. via GET /api/v3/search/milestones

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. via GET /api/v3/search/objectives

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. via GET /api/v3/search/stories

Get Story returns information about a chosen Story. via GET /api/v3/stories/{story-public-id}

Lists Comments associated with a Story via GET /api/v3/stories/{story-public-id}/comments

Get Comment is used to get Comment information. via GET /api/v3/stories/{story-public-id}/comments/{comment-public-id}

Story History via GET /api/v3/stories/{story-public-id}/history

List Story Sub tasks returns a list of all Sub-task Stories for a given parent Story. via GET /api/v3/stories/{story-public-id}/sub-tasks

Returns information about a chosen Task. via GET /api/v3/stories/{story-public-id}/tasks/{task-public-id}

Returns the stories and their relationship for the given Story Link. via GET /api/v3/story-links/{story-link-public-id}

Returns a list of all Workflows in the Workspace. via GET /api/v3/workflows

Get Workflow returns information about a chosen Workflow. via GET /api/v3/workflows/{workflow-public-id}

Create Category allows you to create a new Category in Shortcut. via POST /api/v3/categories

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. via POST /api/v3/documents

Create a new entity template for the Workspace. via POST /api/v3/entity-templates

Create Epic allows you to create a new Epic in Shortcut. via POST /api/v3/epics

This endpoint allows you to create a threaded Comment on an Epic. via POST /api/v3/epics/{epic-public-id}/comments

This endpoint allows you to create a nested Comment reply to an existing Epic Comment. via POST /api/v3/epics/{epic-public-id}/comments/{comment-public-id}

Create a new health status for the specified Epic. via POST /api/v3/epics/{epic-public-id}/health

Create Group via POST /api/v3/groups

Create Generic Integration via POST /api/v3/integrations/webhook

Create Iteration via POST /api/v3/iterations

Create Label allows you to create a new Label in Shortcut. via POST /api/v3/labels

Create Linked File allows you to create a new Linked File in Shortcut. via POST /api/v3/linked-files

Create Objective allows you to create a new Objective in Shortcut. via POST /api/v3/objectives

Create a new health status for the specified Objective. via POST /api/v3/objectives/{objective-public-id}/health

Create Project is used to create a new Shortcut Project. via POST /api/v3/projects

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. via POST /api/v3/stories

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). via POST /api/v3/stories/bulk

Create Comment allows you to create a Comment on any Story. via POST /api/v3/stories/{story-public-id}/comments

Create a reaction to a story comment. via POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions

Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced) via POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack

Create Task is used to create a new task in a Story. via POST /api/v3/stories/{story-public-id}/tasks

Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace. via POST /api/v3/stories/from-template

Search Stories lets you search Stories based on desired parameters. via POST /api/v3/stories/search

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” via POST /api/v3/story-links

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. via PUT /api/v3/categories/{category-public-id}

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'}). via PUT /api/v3/custom-fields/{custom-field-public-id}

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. (2) For non-migrated docs, CKEditor cache is flushed and SSE events notify connected CKEditor users. via PUT /api/v3/documents/{doc-public-id}

Create a relationship between a Document and an Epic. via PUT /api/v3/documents/{doc-public-id}/epics/{epic-public-id}

Update an entity template's name or its contents. via PUT /api/v3/entity-templates/{entity-template-public-id}

Disables the Story Template feature for the Workspace. via PUT /api/v3/entity-templates/disable

Enables the Story Template feature for the Workspace. via PUT /api/v3/entity-templates/enable

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. via PUT /api/v3/epics/{epic-public-id}

This endpoint allows you to update a threaded Comment on an Epic. via PUT /api/v3/epics/{epic-public-id}/comments/{comment-public-id}

Update File updates the properties of an UploadedFile (but not its content). via PUT /api/v3/files/{file-public-id}

Update Group via PUT /api/v3/groups/{group-public-id}

Update an existing health status by its ID. via PUT /api/v3/health/{health-public-id}

Update Iteration via PUT /api/v3/iterations/{iteration-public-id}

Disables Iterations for the current workspace via PUT /api/v3/iterations/disable

Enables Iterations for the current workspace via PUT /api/v3/iterations/enable

Update Key Result allows updating a Key Result's name or initial, observed, or target values. via PUT /api/v3/key-results/{key-result-public-id}

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. via PUT /api/v3/labels/{label-public-id}

Updated Linked File allows you to update properties of a previously attached Linked-File. via PUT /api/v3/linked-files/{linked-file-public-id}

Update Objective can be used to update Objective properties. via PUT /api/v3/objectives/{objective-public-id}

Update Project can be used to change properties of a Project. via PUT /api/v3/projects/{project-public-id}

Update Multiple Stories allows you to make changes to numerous stories at once. via PUT /api/v3/stories/bulk

Update Story can be used to update Story properties. via PUT /api/v3/stories/{story-public-id}

Update Comment replaces the text of the existing Comment. via PUT /api/v3/stories/{story-public-id}/comments/{comment-public-id}

Update Task can be used to update Task properties. via PUT /api/v3/stories/{story-public-id}/tasks/{task-public-id}

Updates the stories and/or the relationship for the given Story Link. via PUT /api/v3/story-links/{story-link-public-id}