Shortcut

Shortcut API

Manage stories, epics, iterations and objectives in a Shortcut workspace

Developer tools#documents--productivity

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Manage stories, epics, iterations and objectives in a Shortcut workspace

Endpoints 257

  • GETGet Whoami/api/v4/whoamiReturns details about the currently-authenticated member and token authorization.
  • GETGet Schema/api/v4/schemas/:schema-nameGets the json-schema for a route.
  • GETList Workspace Tokens/api/v4/:workspace-slug/admin/tokensList Workspace Tokens returns a paginated list of all API Tokens in the Workspace. Requires admin role.
  • DELETEDelete Workspace Token/api/v4/:workspace-slug/admin/tokens/:token-public-idDelete Workspace Token disables an API Token in the Workspace. Requires admin role.
  • GETList Agent Sessions/api/v4/:workspace-slug/agent-sessions?entity_type=story&entity_id=0List sessions on a Story or Epic, newest first.
  • POSTCreate Agent Session/api/v4/:workspace-slug/agent-sessionsCreate work owned by the authenticated agent on a Story or Epic. Repeated identical idempotency keys return the same session.
  • PUTSubscribe to Agent Sessions/api/v4/:workspace-slug/agent-sessions/subscriptionOpt the authenticated agent installation into session events instead of legacy interaction webhooks.
  • GETGet Agent Session/api/v4/:workspace-slug/agent-sessions/:agent-session-idGet a session visible to the current member.
  • PATCHUpdate Agent Session/api/v4/:workspace-slug/agent-sessions/:agent-session-idReplace a session plan or external links using its current version.
  • GETGet Agent Session Context/api/v4/:workspace-slug/agent-sessions/:agent-session-id/contextGet current authorized entity context for a session.
  • POSTPrompt Agent Session/api/v4/:workspace-slug/agent-sessions/:agent-session-id/promptsContinue an explicitly selected session or request that its agent stop.
  • GETList Agent Activities/api/v4/:workspace-slug/agent-sessions/:agent-session-id/activitiesRead session activities in stable sequence order.
  • POSTCreate Agent Activity/api/v4/:workspace-slug/agent-sessions/:agent-session-id/activitiesPublish a typed activity as the agent owning the session.
  • GETList Branches/api/v4/:workspace-slug/branchesList Branches returns a paginated list of all Branches in the Workspace that have either been associated with a Story, or used in a Pull Request that was…
  • GETGet Branch/api/v4/:workspace-slug/branches/:branch-public-idGet Branch returns information about a chosen Branch.
  • GETList Branch Stories/api/v4/:workspace-slug/branches/:branch-public-id/storiesList Branch Stories returns a paginated list of all Stories associated with a Branch in the Workspace.
  • GETList Branch Pull Requests/api/v4/:workspace-slug/branches/:branch-public-id/pull-requestsList Branch Pull Requests returns a paginated list of all Pull Requests associated with a Branch in the Workspace.
  • GETList Categories/api/v4/:workspace-slug/categoriesList Categories returns a paginated list of all Categories in the Workspace.
  • POSTCreate Category/api/v4/:workspace-slug/categoriesCreate Category allows you to create a new Category in Shortcut.
  • POSTBulk Create Categories/api/v4/:workspace-slug/categories/bulkBulk Create Categories creates multiple Categories, and returns a paginated list of the created Categories.
  • DELETEBulk Delete Categories/api/v4/:workspace-slug/categories/bulkBulk Delete Categories deletes multiple Categories.
  • PATCHBulk Update Categories/api/v4/:workspace-slug/categories/bulkBulk Update Categories updates multiple Categories, and returns a paginated list of the updated Categories.
  • GETGet Category/api/v4/:workspace-slug/categories/:category-public-idGet Category returns information about a chosen Category.
  • DELETEDelete Category/api/v4/:workspace-slug/categories/:category-public-idDelete Category removes a Category from the Workspace.
  • PATCHUpdate Category/api/v4/:workspace-slug/categories/:category-public-idUpdate Category allows you to modify a Category in your Shortcut Workspace.
  • GETList Category Objectives/api/v4/:workspace-slug/categories/:category-public-id/objectivesList Category Objectives returns a paginated list of all Objectives associated with a Category in the Workspace.
  • GETList Collections/api/v4/:workspace-slug/collectionsList Collections returns a paginated list of all Collections in the Workspace.
  • POSTCreate Collection/api/v4/:workspace-slug/collectionsCreate Collection allows you to create a new Collection in the Workspace.
  • GETGet Collection/api/v4/:workspace-slug/collections/:collection-public-idGet Collection returns information about a chosen Collection.
  • PUTFavorite Collection/api/v4/:workspace-slug/collections/:collection-public-id/favoriteFavorite Collection marks the Collection as a favorite of the current Member, and returns the updated Collection.
  • DELETEUnfavorite Collection/api/v4/:workspace-slug/collections/:collection-public-id/favoriteUnfavorite Collection removes the Collection from the current Member's favorites.
  • GETList Commits/api/v4/:workspace-slug/commitsList Commits returns a paginated list of all Commits in the Workspace that have been associated with Stories.
  • GETGet Commit/api/v4/:workspace-slug/commits/:commit-public-idGet Commit returns information about a chosen Commit.
  • GETList Commit Stories/api/v4/:workspace-slug/commits/:commit-public-id/storiesList Commit Stories returns a paginated list of all Stories associated with a Commit in the Workspace.
  • GETList Custom Fields/api/v4/:workspace-slug/custom-fieldsList Custom Fields returns a paginated list of all Custom Fields in the Workspace.
  • DELETEBulk Delete Custom Fields/api/v4/:workspace-slug/custom-fields/bulkBulk Delete Custom Fields removes multiple Custom Fields from the Workspace.
  • PATCHBulk Update Custom Fields/api/v4/:workspace-slug/custom-fields/bulkBulk Update Custom Fields updates multiple Custom Fields, and returns a paginated list of the updated Custom Fields.
  • GETGet Custom Field/api/v4/:workspace-slug/custom-fields/:custom-field-public-idGet Custom Field returns information about a chosen Custom Field.
  • DELETEDelete Custom Field/api/v4/:workspace-slug/custom-fields/:custom-field-public-idDelete Custom Field removes a Custom Field from the Workspace.
  • PATCHUpdate Custom Field/api/v4/:workspace-slug/custom-fields/:custom-field-public-idUpdate Custom Field allows you to modify a Custom Field definition in your Shortcut Workspace.
  • GETList Custom Field Stories/api/v4/:workspace-slug/custom-fields/:custom-field-public-id/storiesReturns a paginated list of all Stories that have a value set for the specified Custom Field.
  • GETList Docs/api/v4/:workspace-slug/documentsList Docs returns a paginated list of all accessible Docs in the Workspace.
  • POSTCreate Doc/api/v4/:workspace-slug/documentsCreate Doc allows you to create a new Doc in the Workspace.
  • POSTBulk Create Docs/api/v4/:workspace-slug/documents/bulkBulk Create Docs creates multiple Docs, and returns a paginated list of the created Docs.
  • GETSearch Docs/api/v4/:workspace-slug/documents/searchSearch Docs lets you search Docs by title, with optional archived/created_by_me/followed_by_me filters.
  • GETGet Doc/api/v4/:workspace-slug/documents/:doc-public-idGet Doc returns information about a chosen Doc. Pass content_format=markdown (default) or content_format=html to include content in the response.
  • PATCHUpdate Doc/api/v4/:workspace-slug/documents/:doc-public-idUpdate Doc changes the title and/or content of a Doc, and returns the updated Doc. New content replaces the existing content. Requires write access to the Doc.
  • GETList Doc Followers/api/v4/:workspace-slug/documents/:doc-public-id/followersList Doc Followers returns a paginated list of all Members following a Doc in the Workspace.
  • GETList Doc Collections/api/v4/:workspace-slug/documents/:doc-public-id/collectionsList Doc Collections returns a paginated list of the Collections the Doc belongs to.
  • PUTAdd Doc to Collection/api/v4/:workspace-slug/documents/:doc-public-id/collections/:collection-public-idAdd Doc to Collection adds the Doc to the chosen Collection, preserving its other Collection memberships, and returns the updated Doc. Requires write access…
  • DELETERemove Doc from Collection/api/v4/:workspace-slug/documents/:doc-public-id/collections/:collection-public-idRemove Doc from Collection removes the Doc from the chosen Collection, preserving its other Collection memberships. Requires write access to the Doc.
  • GETList Entity Templates/api/v4/:workspace-slug/entity-templatesList Entity Templates returns a paginated list of all Entity Templates in the Workspace.
  • POSTCreate Entity Template/api/v4/:workspace-slug/entity-templatesCreate Entity Template creates a new Entity Template in your Shortcut Workspace.
  • POSTBulk Create Entity Templates/api/v4/:workspace-slug/entity-templates/bulkBulk Create Entity Templates creates multiple Entity Templates, and returns a paginated list of the created Entity Templates.
  • DELETEBulk Delete Entity Templates/api/v4/:workspace-slug/entity-templates/bulkBulk Delete Entity Templates removes multiple Entity Templates from the Workspace.
  • PATCHBulk Update Entity Templates/api/v4/:workspace-slug/entity-templates/bulkBulk Update Entity Templates updates multiple Entity Templates, and returns a paginated list of the updated Entity Templates.
  • GETGet Entity Template/api/v4/:workspace-slug/entity-templates/:entity-template-public-idGet Entity Template returns information about a given Entity Template.
  • DELETEDelete Entity Template/api/v4/:workspace-slug/entity-templates/:entity-template-public-idDelete Entity Template removes an Entity Template from the Workspace.
  • PATCHUpdate Entity Template/api/v4/:workspace-slug/entity-templates/:entity-template-public-idUpdate Entity Template updates an existing Entity Template in your Shortcut Workspace.
  • GETGet Epic Workflow/api/v4/:workspace-slug/epic-workflowReturns the Epic Workflow configuration for the Workspace.
  • GETList Epic Workflow States/api/v4/:workspace-slug/epic-workflow/statesReturns a paginated list of all Epic States in the Workspace's Epic Workflow.
  • GETList Epics/api/v4/:workspace-slug/epicsList Epics returns a paginated list of all Epics in the Workspace.
  • POSTCreate Epic/api/v4/:workspace-slug/epicsCreate Epic is used to create a new Epic in your Shortcut Workspace.
  • POSTBulk Create Epics/api/v4/:workspace-slug/epics/bulkBulk Create Epics creates multiple Epics, and returns a paginated list of the created Epics.
  • DELETEBulk Delete Epics/api/v4/:workspace-slug/epics/bulkBulk Delete Epics deletes multiple Epics. The Epics must be archived unless force is set.
  • PATCHBulk Update Epics/api/v4/:workspace-slug/epics/bulkBulk Update Epics updates multiple Epics, and returns a paginated list of the updated Epics.
  • GETSearch Epics/api/v4/:workspace-slug/epics/searchSearch Epics lets you search Epics based on a query.
  • GETGet Epic/api/v4/:workspace-slug/epics/:epic-public-idGet Epic returns information about a chosen Epic.
  • DELETEDelete Epic/api/v4/:workspace-slug/epics/:epic-public-idDelete Epic removes an Epic from the Workspace. The Epic must be archived unless force is set.
  • PATCHUpdate Epic/api/v4/:workspace-slug/epics/:epic-public-idUpdate Epic is used to modify an Epic in your Shortcut Workspace.
  • GETGet Epic Stats/api/v4/:workspace-slug/epics/:epic-public-id/statsGet Epic Stats returns calculated stats for a chosen Epic. Stats are served from this dedicated sub-endpoint (rather than the Epic response itself) to avoid…
  • GETList Epic Teams/api/v4/:workspace-slug/epics/:epic-public-id/teamsList Epic Teams returns a paginated list of all Teams associated with an Epic in the Workspace.
  • GETList Epic Labels/api/v4/:workspace-slug/epics/:epic-public-id/labelsList Epic Labels returns a paginated list of all Labels for an Epic in the Workspace.
  • GETList Epic Owners/api/v4/:workspace-slug/epics/:epic-public-id/ownersList Epic Owners returns a paginated list of all Members who own an Epic in the Workspace.
  • GETList Epic Stories/api/v4/:workspace-slug/epics/:epic-public-id/storiesList Epic Stories returns a paginated list of all Stories associated with an Epic in the Workspace.
  • GETList Epic Comments/api/v4/:workspace-slug/epics/:epic-public-id/commentsList Epic Comments returns a paginated list of all Comments for an Epic in the Workspace. Note that deleted comments will also be returned, but will have…
  • POSTCreate Epic Comment/api/v4/:workspace-slug/epics/:epic-public-id/commentsCreate Epic Comment is used to add a new Comment to an Epic. To reply to an existing Comment, provide a parent_comment_id.
  • GETList Epic Followers/api/v4/:workspace-slug/epics/:epic-public-id/followersList Epic Followers returns a paginated list of all Members who are following an Epic in the Workspace.
  • GETList Epic Objectives/api/v4/:workspace-slug/epics/:epic-public-id/objectivesList Epic Objectives returns a paginated list of all Objectives associated with an Epic in the Workspace.
  • GETList Epic Healths/api/v4/:workspace-slug/epics/:epic-public-id/epic-healthsReturns a paginated list of Health updates for the specified Epic.
  • POSTCreate Epic Health/api/v4/:workspace-slug/epics/:epic-public-id/epic-healthsCreates a new Health update for the specified Epic.
  • POSTBulk Create Epic Comments/api/v4/:workspace-slug/epics/:epic-public-id/comments/bulkBulk Create Epic Comments creates multiple Comments on an Epic, and returns a paginated list of the created Comments.
  • DELETEBulk Delete Epic Comments/api/v4/:workspace-slug/epics/:epic-public-id/comments/bulkBulk Delete Epic Comments deletes multiple Comments from an Epic.
  • PATCHBulk Update Epic Comments/api/v4/:workspace-slug/epics/:epic-public-id/comments/bulkBulk Update Epic Comments updates multiple Comments on an Epic, and returns a paginated list of the updated Comments.
  • GETList Epic Mentioned Teams/api/v4/:workspace-slug/epics/:epic-public-id/mentioned-teamsList Epic Mentioned Teams returns a paginated list of all Teams mentioned in an Epic in the Workspace.
  • GETList Epic Mentioned Members/api/v4/:workspace-slug/epics/:epic-public-id/mentioned-membersList Epic Mentioned Members returns a paginated list of all Members mentioned in an Epic in the Workspace.
  • GETGet Epic Comment/api/v4/:workspace-slug/epics/:epic-public-id/comments/:comment-public-idGet Epic Comment returns information about a chosen Epic Comment.
  • DELETEDelete Epic Comment/api/v4/:workspace-slug/epics/:epic-public-id/comments/:comment-public-idDelete a Comment from an Epic.
  • PATCHUpdate Epic Comment/api/v4/:workspace-slug/epics/:epic-public-id/comments/:comment-public-idUpdate Epic Comment is used to modify an existing Epic Comment.
  • GETGet Epic Health/api/v4/:workspace-slug/epics/:epic-public-id/epic-healths/:epic-health-public-idReturns a Health for the specified Epic.
  • GETList Epic Comment Comments/api/v4/:workspace-slug/epics/:epic-public-id/comments/:comment-public-id/commentsList Epic Comment Comments returns a paginated list of all threaded reply Comments for an Epic Comment in the Workspace.
  • GETList Epic Comment Mentioned Teams/api/v4/:workspace-slug/epics/:epic-public-id/comments/:comment-public-id/mentioned-teamsList Epic Comment Mentioned Teams returns a paginated list of all Teams mentioned in an Epic Comment in the Workspace.
  • GETList Epic Comment Mentioned Members/api/v4/:workspace-slug/epics/:epic-public-id/comments/:comment-public-id/mentioned-membersList Epic Comment Mentioned Members returns a paginated list of all Members mentioned in an Epic Comment in the Workspace.
  • GETList Files/api/v4/:workspace-slug/filesList Files returns a paginated list of all Files in the Workspace.
  • POSTUpload Files/api/v4/:workspace-slug/filesUpload Files uploads one or more files and optionally associates them with a Story. Use the multipart/form-data content-type to upload. Each file key should…
  • DELETEBulk Delete Files/api/v4/:workspace-slug/files/bulkBulk Delete Files deletes multiple Files from the Workspace.
  • GETGet File/api/v4/:workspace-slug/files/:file-public-idGet File returns information about the chosen File.
  • DELETEDelete File/api/v4/:workspace-slug/files/:file-public-idDelete File removes a previously uploaded File from the Workspace.
  • GETList File Stories/api/v4/:workspace-slug/files/:file-public-id/storiesList File Stories returns a paginated list of all Stories associated with a File in the Workspace.
  • GETList File Mentioned Teams/api/v4/:workspace-slug/files/:file-public-id/mentioned-teamsList File Mentioned Teams returns a paginated list of all Teams mentioned in a File in the Workspace.
  • GETList File Mentioned Members/api/v4/:workspace-slug/files/:file-public-id/mentioned-membersList File Mentioned Members returns a paginated list of all Members mentioned in a File in the Workspace.
  • GETList Iterations/api/v4/:workspace-slug/iterationsList Iterations returns a paginated list of all Iterations in the Workspace.
  • POSTCreate Iteration/api/v4/:workspace-slug/iterationsCreate Iteration is used to create a new Iteration in your Shortcut Workspace.
  • POSTBulk Create Iterations/api/v4/:workspace-slug/iterations/bulkBulk Create Iterations creates multiple Iterations, and returns a paginated list of the created Iterations.
  • DELETEBulk Delete Iterations/api/v4/:workspace-slug/iterations/bulkBulk Delete Iterations deletes multiple Iterations.
  • PATCHBulk Update Iterations/api/v4/:workspace-slug/iterations/bulkBulk Update Iterations updates multiple Iterations, and returns a paginated list of the updated Iterations.
  • GETSearch Iterations/api/v4/:workspace-slug/iterations/searchSearch Iterations lets you search Iterations based on a query.
  • GETGet Current Iterations/api/v4/:workspace-slug/iterations/currentReturns all currently started iterations for the authenticated user based on their team memberships. The 'current' iterations are determined by finding…
  • GETGet Iteration/api/v4/:workspace-slug/iterations/:iteration-public-idGet Iteration returns information about a chosen Iteration.
  • DELETEDelete Iteration/api/v4/:workspace-slug/iterations/:iteration-public-idDelete Iteration removes an Iteration from the Workspace.
  • PATCHUpdate Iteration/api/v4/:workspace-slug/iterations/:iteration-public-idUpdate Iteration is used to modify an Iteration in your Shortcut Workspace.
  • GETList Iteration Teams/api/v4/:workspace-slug/iterations/:iteration-public-id/teamsList Iteration Teams returns a paginated list of all Teams directly associated with an Iteration in the Workspace.
  • GETList Iteration Labels/api/v4/:workspace-slug/iterations/:iteration-public-id/labelsList Iteration Labels returns a paginated list of all Labels for an Iteration in the Workspace.
  • GETList Iteration Stories/api/v4/:workspace-slug/iterations/:iteration-public-id/storiesList Iteration Stories returns a paginated list of all Stories in an Iteration in the Workspace.
  • GETList Iteration Followers/api/v4/:workspace-slug/iterations/:iteration-public-id/followersList Iteration Followers returns a paginated list of all Members who are following an Iteration in the Workspace.
  • GETList Iteration Mentioned Teams/api/v4/:workspace-slug/iterations/:iteration-public-id/mentioned-teamsList Iteration Mentioned Teams returns a paginated list of all Teams mentioned in an Iteration in the Workspace.
  • GETList Iteration Associated Teams/api/v4/:workspace-slug/iterations/:iteration-public-id/associated-teamsList Iteration Associated Teams returns a paginated list of all Teams that own Stories in an Iteration but are not directly associated with the Iteration.
  • GETList Iteration Mentioned Members/api/v4/:workspace-slug/iterations/:iteration-public-id/mentioned-membersList Iteration Mentioned Members returns a paginated list of all Members mentioned in an Iteration in the Workspace.
  • GETList Key Results/api/v4/:workspace-slug/key-resultsReturns a paginated list of all Key Results in the Workspace.
  • GETGet Key Result/api/v4/:workspace-slug/key-results/:key-result-public-idReturns the specified Key Result.
  • PUTUpdate Key Result/api/v4/:workspace-slug/key-results/:key-result-public-idUpdates the specified Key Result.
  • GETList Labels/api/v4/:workspace-slug/labelsList Labels returns a paginated list of all Labels in the Workspace.
  • POSTCreate Label/api/v4/:workspace-slug/labelsCreate Label allows you to create a new Label in Shortcut.
  • POSTBulk Create Labels/api/v4/:workspace-slug/labels/bulkBulk Create Labels creates multiple Labels, and returns a paginated list of the created Labels.
  • DELETEBulk Delete Labels/api/v4/:workspace-slug/labels/bulkBulk Delete Labels deletes multiple Labels.
  • PATCHBulk Update Labels/api/v4/:workspace-slug/labels/bulkBulk Update Labels updates multiple Labels, and returns a paginated list of the updated Labels.
  • GETGet Label/api/v4/:workspace-slug/labels/:label-public-idGet Label returns information about a chosen Label.
  • DELETEDelete Label/api/v4/:workspace-slug/labels/:label-public-idDelete Label removes a Label from the Workspace.
  • PATCHUpdate Label/api/v4/:workspace-slug/labels/:label-public-idUpdate Label allows you to modify a Label in your Shortcut Workspace.
  • GETList Label Epics/api/v4/:workspace-slug/labels/:label-public-id/epicsList Label Epics returns a paginated list of all Epics that have a given Label.
  • GETList Label Stories/api/v4/:workspace-slug/labels/:label-public-id/storiesList Label Stories returns a paginated list of all Stories that have a given Label.
  • GETList Linked Files/api/v4/:workspace-slug/linked-filesList Linked Files returns a paginated list of all Linked Files in the Workspace.
  • POSTCreate Linked File/api/v4/:workspace-slug/linked-filesCreate Linked File is used to add a new Linked File to your Shortcut Workspace.
  • POSTBulk Create Linked Files/api/v4/:workspace-slug/linked-files/bulkBulk Create Linked Files creates multiple Linked Files, and returns a paginated list of the created Linked Files.
  • DELETEBulk Delete Linked Files/api/v4/:workspace-slug/linked-files/bulkBulk Delete Linked Files deletes multiple Linked Files.
  • PATCHBulk Update Linked Files/api/v4/:workspace-slug/linked-files/bulkBulk Update Linked Files updates multiple Linked Files, and returns a paginated list of the updated Linked Files.
  • GETGet Linked File/api/v4/:workspace-slug/linked-files/:linked-file-public-idGet Linked File returns information about the chosen Linked File.
  • DELETEDelete Linked File/api/v4/:workspace-slug/linked-files/:linked-file-public-idDelete Linked File removes a Linked File from the Workspace.
  • PATCHUpdate Linked File/api/v4/:workspace-slug/linked-files/:linked-file-public-idUpdate Linked File is used to update an existing Linked File in your Shortcut Workspace.
  • GETList Linked File Stories/api/v4/:workspace-slug/linked-files/:linked-file-public-id/storiesList Linked File Stories returns a paginated list of all Stories associated with a Linked File in the Workspace.
  • GETList Linked File Mentioned Teams/api/v4/:workspace-slug/linked-files/:linked-file-public-id/mentioned-teamsList Linked File Mentioned Teams returns a paginated list of all Teams mentioned in a Linked File in the Workspace.
  • GETList Linked File Mentioned Members/api/v4/:workspace-slug/linked-files/:linked-file-public-id/mentioned-membersList Linked File Mentioned Members returns a paginated list of all Members mentioned in a Linked File in the Workspace.
  • GETList Members/api/v4/:workspace-slug/membersList Members returns a paginated list of all Members in the Workspace.
  • PATCHBulk Update Members/api/v4/:workspace-slug/members/bulkBulk Update Members updates multiple Members and returns a paginated list of the updated Members.
  • GETGet Member/api/v4/:workspace-slug/members/:member-public-idGet Member returns information about a Member of the Workspace.
  • PATCHUpdate Member/api/v4/:workspace-slug/members/:member-public-idUpdate Member modifies a Member's role or disabled status in the Workspace.
  • GETList Member Teams/api/v4/:workspace-slug/members/:member-public-id/teamsReturns a paginated list of all Teams the Member belongs to.
  • GETList Member Stories/api/v4/:workspace-slug/members/:member-public-id/storiesReturns a paginated list of all Stories owned by the specified Member.
  • GETList Objectives/api/v4/:workspace-slug/objectivesList Objectives returns a paginated list of all Objectives in the Workspace.
  • POSTCreate Objective/api/v4/:workspace-slug/objectivesCreate Objective is used to create a new Objective in your Shortcut Workspace.
  • POSTBulk Create Objectives/api/v4/:workspace-slug/objectives/bulkBulk Create Objectives creates multiple Objectives, and returns a paginated list of the created Objectives.
  • DELETEBulk Delete Objectives/api/v4/:workspace-slug/objectives/bulkBulk Delete Objectives deletes multiple Objectives.
  • PATCHBulk Update Objectives/api/v4/:workspace-slug/objectives/bulkBulk Update Objectives updates multiple Objectives, and returns a paginated list of the updated Objectives.
  • GETSearch Objectives/api/v4/:workspace-slug/objectives/searchSearch Objectives lets you search Objectives based on a query.
  • GETGet Objective/api/v4/:workspace-slug/objectives/:objective-public-idGet Objective returns information about a chosen Objective.
  • DELETEDelete Objective/api/v4/:workspace-slug/objectives/:objective-public-idDelete Objective removes an Objective from the Workspace.
  • PATCHUpdate Objective/api/v4/:workspace-slug/objectives/:objective-public-idUpdate Objective is used to modify an Objective in your Shortcut Workspace.
  • GETList Objective Epics/api/v4/:workspace-slug/objectives/:objective-public-id/epicsList Objective Epics returns a paginated list of all Epics associated with an Objective in the Workspace.
  • GETList Objective Teams/api/v4/:workspace-slug/objectives/:objective-public-id/teamsList Objective Teams returns a paginated list of all Teams associated with an Objective in the Workspace.
  • GETList Objective Owners/api/v4/:workspace-slug/objectives/:objective-public-id/ownersList Objective Owners returns a paginated list of all Members who own an Objective in the Workspace.
  • GETList Objective Categories/api/v4/:workspace-slug/objectives/:objective-public-id/categoriesList Objective Categories returns a paginated list of all Categories associated with an Objective in the Workspace.
  • GETList Objective Key Results/api/v4/:workspace-slug/objectives/:objective-public-id/key-resultsList Objective Key Results returns a paginated list of all Key Results associated with an Objective in the Workspace.
  • GETList Objective Healths/api/v4/:workspace-slug/objectives/:objective-public-id/objective-healthsReturns a paginated list of Health updates for the specified Objective.
  • POSTCreate Objective Health/api/v4/:workspace-slug/objectives/:objective-public-id/objective-healthsCreates a new Health update for the specified Objective.
  • GETGet Objective Health/api/v4/:workspace-slug/objectives/:objective-public-id/objective-healths/:objective-health-public-idReturns a Health for the specified Objective.
  • GETList Projects/api/v4/:workspace-slug/projectsDeprecated. List Projects returns a paginated list of all Projects in the Workspace. Projects are a deprecated feature.
  • POSTCreate Project/api/v4/:workspace-slug/projectsDeprecated. Create Project allows you to create a new Project in Shortcut. Projects are a deprecated feature.
  • GETGet Project/api/v4/:workspace-slug/projects/:project-public-idDeprecated. Get Project returns information about the chosen Project. Projects are a deprecated feature.
  • DELETEDelete Project/api/v4/:workspace-slug/projects/:project-public-idDeprecated. Delete Project can be used to delete any Project. Projects are a deprecated feature.
  • PATCHUpdate Project/api/v4/:workspace-slug/projects/:project-public-idDeprecated. Update Project can be used to update Project properties. Projects are a deprecated feature.
  • GETList Project Stories/api/v4/:workspace-slug/projects/:project-public-id/storiesDeprecated. List Project Stories returns a paginated list of all Stories associated with a Project. Projects are a deprecated feature.
  • GETList Project Followers/api/v4/:workspace-slug/projects/:project-public-id/followersDeprecated. List Project Followers returns a paginated list of all Members following a Project. Projects are a deprecated feature.
  • GETList Pull Requests/api/v4/:workspace-slug/pull-requestsList Pull Requests returns a paginated list of all Pull Requests in the Workspace that have been associated with a Story.
  • GETGet Pull Request/api/v4/:workspace-slug/pull-requests/:pull-request-public-idGet Pull Request returns information about a chosen Pull Request.
  • GETList Pull Request Stories/api/v4/:workspace-slug/pull-requests/:pull-request-public-id/storiesList Pull Request Stories returns a paginated list of all Stories associated with a Pull Request in the Workspace.
  • GETList Repositories/api/v4/:workspace-slug/repositoriesList Repositories returns a paginated list of all connected Repositories in the Workspace.
  • GETGet Repository/api/v4/:workspace-slug/repositories/:repository-public-idGet Repository returns information about a connected Repository.
  • GETList Repository Commits/api/v4/:workspace-slug/repositories/:repository-public-id/commitsList Repository Commits returns a paginated list of all Commits associated with a Repository in the Workspace.
  • GETList Repository Branches/api/v4/:workspace-slug/repositories/:repository-public-id/branchesList Repository Branches returns a paginated list of all Branches associated with a Repository in the Workspace.
  • GETList Repository Pull Requests/api/v4/:workspace-slug/repositories/:repository-public-id/pull-requestsList Repository Pull Requests returns a paginated list of all Pull Requests associated with a Repository in the Workspace.
  • GETSearch/api/v4/:workspace-slug/searchSearch lets you search across Epics, Stories, Iterations, Objectives, and Docs with a single query, returning one combined, paginated list of results.
  • GETList Stories/api/v4/:workspace-slug/storiesList Stories returns a paginated list of all Stories in the Workspace.
  • POSTCreate Story/api/v4/:workspace-slug/storiesCreate Story is used to add a new Story to your Shortcut Workspace.
  • POSTBulk Create Stories/api/v4/:workspace-slug/stories/bulkBulk Create Stories creates multiple Stories, and returns a paginated list of the created Stories.
  • DELETEBulk Delete Stories/api/v4/:workspace-slug/stories/bulkBulk Delete Stories deletes multiple Stories. The Stories must be archived unless force is set.
  • PATCHBulk Update Stories/api/v4/:workspace-slug/stories/bulkBulk Update Stories updates multiple Stories, and returns a paginated list of the updated Stories.
  • GETSearch Stories/api/v4/:workspace-slug/stories/searchSearch Stories lets you search Stories based on a query.
  • GETGet Multiple Stories History/api/v4/:workspace-slug/stories/historyReturns history of changes for multiple Stories in chronological order (oldest first by default; newest first with order_dir=desc), across all attributes,…
  • GETGet Story/api/v4/:workspace-slug/stories/:story-public-idGet Story returns information about a chosen Story.
  • DELETEDelete Story/api/v4/:workspace-slug/stories/:story-public-idDelete Story can be used to delete a Story. The Story must be archived unless force is set.
  • PATCHUpdate Story/api/v4/:workspace-slug/stories/:story-public-idUpdate Story is used to modify a Story in your Shortcut Workspace.
  • GETList Story Files/api/v4/:workspace-slug/stories/:story-public-id/filesList Story Files returns a paginated list of all Files attached to a Story in the Workspace.
  • GETList Story Labels/api/v4/:workspace-slug/stories/:story-public-id/labelsList Story Labels returns a paginated list of all Labels for a Story in the Workspace.
  • GETList Story Owners/api/v4/:workspace-slug/stories/:story-public-id/ownersList Story Owners returns a paginated list of all Members who own a Story in the Workspace.
  • GETList Story Commits/api/v4/:workspace-slug/stories/:story-public-id/commitsList Story Commits returns a paginated list of all Commits associated with a Story in the Workspace.
  • GETGet Story History/api/v4/:workspace-slug/stories/:story-public-id/historyReturns history of changes for a Story in chronological order (oldest first by default; newest first with order_dir=desc), across all attributes, with a…
  • GETList Story Branches/api/v4/:workspace-slug/stories/:story-public-id/branchesList Story Branches returns a paginated list of all Branches for a Story in the Workspace.
  • GETList Story Comments/api/v4/:workspace-slug/stories/:story-public-id/commentsList Story Comments returns a paginated list of all Comments for a Story in the Workspace. Note that deleted comments will also be returned, but will have…
  • POSTCreate Story Comment/api/v4/:workspace-slug/stories/:story-public-id/commentsCreate Story is used to add a new Comment to a Story.
  • GETList Story Followers/api/v4/:workspace-slug/stories/:story-public-id/followersList Story Followers returns a paginated list of all Members who are following a Story in the Workspace.
  • GETList Story Iterations/api/v4/:workspace-slug/stories/:story-public-id/iterationsList Story Iterations returns a paginated list of all Iterations associated with a Story in the Workspace.
  • GETList Story Story Links/api/v4/:workspace-slug/stories/:story-public-id/story-linksList Story Story Links returns a paginated list of all Story Links associated with a Story in the Workspace. This includes links where the Story is either the…
  • GETList Story Linked Files/api/v4/:workspace-slug/stories/:story-public-id/linked-filesList Story Linked Files returns a paginated list of all Linked Files attached to a Story in the Workspace.
  • POSTBulk Create Story Comments/api/v4/:workspace-slug/stories/:story-public-id/comments/bulkBulk Create Story Comments creates multiple Comments on a Story, and returns a paginated list of the created Comments.
  • DELETEBulk Delete Story Comments/api/v4/:workspace-slug/stories/:story-public-id/comments/bulkBulk Delete Story Comments deletes multiple Comments from a Story.
  • PATCHBulk Update Story Comments/api/v4/:workspace-slug/stories/:story-public-id/comments/bulkBulk Update Story Comments updates multiple Comments on a Story, and returns a paginated list of the updated Comments.
  • GETList Story Pull Requests/api/v4/:workspace-slug/stories/:story-public-id/pull-requestsList Story Pull Requests returns a paginated list of all Pull Requests associated with a Story in the Workspace.
  • GETList Story External Links/api/v4/:workspace-slug/stories/:story-public-id/external-linksList Story External Links returns a paginated list of all External Links for a Story in the Workspace.
  • GETList Story Checklist Items/api/v4/:workspace-slug/stories/:story-public-id/checklist-itemsList Story Checklist Items returns a paginated list of all Checklist Items for a Story in the Workspace.
  • POSTCreate Story Checklist Item/api/v4/:workspace-slug/stories/:story-public-id/checklist-itemsCreate Story Checklist Item is used to add a new Checklist Item to a Story.
  • GETList Story Mentioned Teams/api/v4/:workspace-slug/stories/:story-public-id/mentioned-teamsList Story Mentioned Teams returns a paginated list of all Teams mentioned in a Story in the Workspace.
  • GETList Story Sub-Task Stories/api/v4/:workspace-slug/stories/:story-public-id/sub-task-storiesList Story Sub-Task Stories returns a paginated list of all Sub-Task Stories for a Story in the Workspace.
  • GETList Story Mentioned Members/api/v4/:workspace-slug/stories/:story-public-id/mentioned-membersList Story Mentioned Members returns a paginated list of all Members mentioned in a Story in the Workspace.
  • GETList Story Custom Field Values/api/v4/:workspace-slug/stories/:story-public-id/custom-field-valuesList Story Custom Field Values returns a paginated list of all Custom Field Values for a Story in the Workspace.
  • POSTBulk Create Story Checklist Items/api/v4/:workspace-slug/stories/:story-public-id/checklist-items/bulkBulk Create Story Checklist Items creates multiple Checklist Items on a Story, and returns a paginated list of the created Checklist Items.
  • DELETEBulk Delete Story Checklist Items/api/v4/:workspace-slug/stories/:story-public-id/checklist-items/bulkBulk Delete Story Checklist Items deletes multiple Checklist Items from a Story.
  • PATCHBulk Update Story Checklist Items/api/v4/:workspace-slug/stories/:story-public-id/checklist-items/bulkBulk Update Story Checklist Items updates multiple Checklist Items on a Story, and returns a paginated list of the updated Checklist Items.
  • GETGet Story Comment/api/v4/:workspace-slug/stories/:story-public-id/comments/:comment-public-idGet Story Comment returns information about a chosen Story Comment.
  • DELETEDelete Story Comment/api/v4/:workspace-slug/stories/:story-public-id/comments/:comment-public-idDelete a Comment from a Story.
  • PATCHUpdate Story Comment/api/v4/:workspace-slug/stories/:story-public-id/comments/:comment-public-idUpdate Story Comment is used to modify a Story Comment.
  • GETList Story Comment Comments/api/v4/:workspace-slug/stories/:story-public-id/comments/:comment-public-id/commentsList Story Comment Comments returns a paginated list of all threaded reply Comments for a Story Comment in the Workspace.
  • GETList Story Comment Reactions/api/v4/:workspace-slug/stories/:story-public-id/comments/:comment-public-id/reactionsList Story Comment Reactions returns a paginated list of all Reactions to a Story Comment in the Workspace.
  • POSTCreate Story Comment Reaction/api/v4/:workspace-slug/stories/:story-public-id/comments/:comment-public-id/reactionsCreate a Reaction to a Story Comment.
  • GETGet Story Checklist Item/api/v4/:workspace-slug/stories/:story-public-id/checklist-items/:checklist-item-public-idGet Story Checklist Item returns information about a chosen Checklist Item for a Story.
  • DELETEDelete Story Checklist Item/api/v4/:workspace-slug/stories/:story-public-id/checklist-items/:checklist-item-public-idDelete a Checklist Item from a Story.
  • PATCHUpdate Story Checklist Item/api/v4/:workspace-slug/stories/:story-public-id/checklist-items/:checklist-item-public-idUpdate Story Checklist Item is used to modify a Checklist Item on a Story.
  • GETList Story Comment Mentioned Teams/api/v4/:workspace-slug/stories/:story-public-id/comments/:comment-public-id/mentioned-teamsList Story Comment Mentioned Teams returns a paginated list of all Teams mentioned in a Story Comment in the Workspace.
  • GETList Story Comment Mentioned Members/api/v4/:workspace-slug/stories/:story-public-id/comments/:comment-public-id/mentioned-membersList Story Comment Mentioned Members returns a paginated list of all Members mentioned in a Story Comment in the Workspace.
  • GETList Story Checklist Item Mentioned Teams/api/v4/:workspace-slug/stories/:story-public-id/checklist-items/:checklist-item-public-id/mentioned-teamsList Story Checklist Item Mentioned Teams returns a paginated list of all Teams mentioned in a Story Checklist Item in the Workspace.
  • DELETEDelete Story Comment Reaction/api/v4/:workspace-slug/stories/:story-public-id/comments/:comment-public-id/reactions/:reaction-public-idDelete a Reaction from a Story Comment.
  • GETList Story Checklist Item Mentioned Members/api/v4/:workspace-slug/stories/:story-public-id/checklist-items/:checklist-item-public-id/mentioned-membersList Story Checklist Item Mentioned Members returns a paginated list of all Members mentioned in a Story Checklist Item in the Workspace.
  • GETList Story Links/api/v4/:workspace-slug/story-linksList Story Links returns a paginated list of all Story Links in the Workspace.
  • POSTCreate Story Link/api/v4/:workspace-slug/story-linksCreate Story Link is used to create a semantic relationship between two Stories. The subject Story acts on the object Story. For example, "Story A blocks…
  • POSTBulk Create Story Links/api/v4/:workspace-slug/story-links/bulkBulk Create Story Links creates multiple Story Links, and returns a paginated list of the created Story Links.
  • DELETEBulk Delete Story Links/api/v4/:workspace-slug/story-links/bulkBulk Delete Story Links deletes multiple Story Links.
  • PATCHBulk Update Story Links/api/v4/:workspace-slug/story-links/bulkBulk Update Story Links updates multiple Story Links, and returns a paginated list of the updated Story Links.
  • GETGet Story Link/api/v4/:workspace-slug/story-links/:story-link-public-idGet Story Link returns information about a chosen Story Link.
  • DELETEDelete Story Link/api/v4/:workspace-slug/story-links/:story-link-public-idDelete Story Link removes the relationship between the Stories for the given Story Link.
  • PATCHUpdate Story Link/api/v4/:workspace-slug/story-links/:story-link-public-idUpdate Story Link is used to modify the stories or verb of an existing Story Link.
  • GETList Teams/api/v4/:workspace-slug/teamsReturns a paginated list of all Teams in the Workspace.
  • POSTCreate Team/api/v4/:workspace-slug/teamsCreates a new Team in the Workspace.
  • POSTBulk Create Teams/api/v4/:workspace-slug/teams/bulkCreates multiple Teams and returns a paginated list of the created Teams.
  • PATCHBulk Update Teams/api/v4/:workspace-slug/teams/bulkUpdates multiple Teams and returns a paginated list of the updated Teams.
  • GETGet Team/api/v4/:workspace-slug/teams/:team-public-idReturns the specified Team.
  • PATCHUpdate Team/api/v4/:workspace-slug/teams/:team-public-idUpdates the specified Team.
  • GETList Team Members/api/v4/:workspace-slug/teams/:team-public-id/membersReturns a paginated list of all Members for the specified Team.
  • GETList Team Stories/api/v4/:workspace-slug/teams/:team-public-id/storiesReturns a paginated list of all Stories assigned to the specified Team.
  • GETList Team Workflows/api/v4/:workspace-slug/teams/:team-public-id/workflowsReturns a paginated list of all Workflows for the specified Team.
  • GETList Workflow States/api/v4/:workspace-slug/workflow-statesReturns a paginated list of all Workflow States in the Workspace.
  • GETGet Workflow State/api/v4/:workspace-slug/workflow-states/:workflow-state-public-idReturns the specified Workflow State.
  • GETList Workflow State Stories/api/v4/:workspace-slug/workflow-states/:workflow-state-public-id/storiesReturns a paginated list of all Stories in the specified Workflow State.
  • GETList Workflows/api/v4/:workspace-slug/workflowsReturns a paginated list of all Workflows in the Workspace.
  • GETGet Workflow/api/v4/:workspace-slug/workflows/:workflow-public-idReturns the specified Workflow.
  • GETList Workflow Teams/api/v4/:workspace-slug/workflows/:workflow-public-id/teamsReturns a paginated list of all Teams associated with the specified Workflow.
  • GETList Workflow States within a Workflow/api/v4/:workspace-slug/workflows/:workflow-public-id/statesReturns a paginated list of all Workflow States within the specified Workflow.
  • GETList Workflow Stories/api/v4/:workspace-slug/workflows/:workflow-public-id/storiesReturns a paginated list of all Stories associated with the specified Workflow.
  • GETList Workflow Projects/api/v4/:workspace-slug/workflows/:workflow-public-id/projectsDeprecated. Returns a paginated list of all Projects associated with the specified Workflow. Projects are a deprecated feature.

API details

Base URL
https://api.app.shortcut.com
Authentication
A bearer token in the Authorization header
Operations
257 operations on 173 pathsGET 150POST 37PATCH 33DELETE 33PUT 4
8 marked deprecated
Description format
OpenAPI 3.0.3, API version 4.0

How to test the Shortcut API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Shortcut API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Whoami” (GET /api/v4/whoami), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Shortcut API?

Manage stories, epics, iterations and objectives in a Shortcut workspace It is listed under Developer tools and has 257 endpoints.

Who publishes the Shortcut API?

It is listed from Shortcut's public API description (an OpenAPI document), not published by Shortcut on Swastik Codes. Anyone who controls shortcut.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Shortcut API?

Requests go to https://api.app.shortcut.com. Endpoint paths are added to this base URL.

How do I authenticate with the Shortcut API?

With A bearer token in the Authorization header.

How many endpoints does the Shortcut API have?

257 operations on 173 paths (150 GET, 37 POST, 33 PATCH, 33 DELETE, 4 PUT).

Is forking the Shortcut API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.