Shortcut for AI agents
Agents read Shortcut at once. Changes and sends are held for a person's approval by default.
About Shortcut
Shortcut aligns product development work with company objectives so teams can execute with a shared purpose.
What an agent can do in Shortcut
Every Shortcut action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Shortcut without asking first. 67 actions.
- Get docGet Doc returns information about a chosen Doc by its public ID. Use content_format=html to include HTML content in the response.
- Get projectGet Project returns information about the selected Project.
- List categoriesList Categories returns a list of all Categories and their attributes.
- List docsTool to list Docs that the current user can read. Use when you need to retrieve all accessible documentation in the Shortcut workspace.
- List epicsList Epics returns a list of all Epics and their attributes.
- List epics paginatedList Epics with pagination returns a paginated list of Epics and their attributes. Use when you need to retrieve Epics in manageable pages rather than all at once.
- List objectivesList Objectives returns a list of all Objectives and their attributes.
- Search documentsTool to search Documents based on title and filters. Use when you need to find specific documents by fuzzy title matching or filter by archived/created_by_me/followed_by_me status.
- Search objectivesSearch 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 f
- Get categoryGet Category returns information about the selected Category.
- Get current member infoReturns information about the authenticated member.
- Get custom fieldRetrieves detailed information about a specific custom field in Shortcut using its unique public identifier. This endpoint allows developers to fetch the properties and configuration of a custom field
Show all 67
- Get entity templateGet Entity Template returns information about a given entity template.
- Get epicGet Epic returns information about the selected Epic.
- Get epic commentThis endpoint returns information about the selected Epic Comment.
- Get epic healthGet the current health status for the specified Epic. Use when you need to check the health status of an Epic.
- Get epic workflowReturns the Epic Workflow for the Workspace.
- Get external link storiesGet Stories which have a given External Link associated with them.
- Get fileGet File returns information about the selected UploadedFile.
- Get generic integrationGet Generic Integration returns information about a webhook integration by its ID. Use when you need to retrieve details about a specific webhook integration.
- Get groupRetrieves detailed information about a specific group in the Shortcut workspace using its unique public identifier. This endpoint allows developers to fetch comprehensive data about a group, including
- Get iterationRetrieves detailed information about a specific iteration in the Shortcut project management system. This endpoint allows users to fetch comprehensive data about a single iteration, including its name
- Get key resultGet Key Result returns information about a chosen Key Result.
- Get labelGet Label returns information about the selected Label.
- Get linked fileGet File returns information about the selected Linked File.
- Get memberReturns information about a Member.
- Get objectiveGet Objective returns information about a chosen Objective.
- Get repositoryGet Repository returns information about the selected Repository.
- Get storyGet Story returns information about a chosen Story.
- Get story commentGet Comment is used to get Comment information.
- Get story linkReturns the stories and their relationship for the given Story Link.
- Get taskReturns information about a chosen Task.
- Get workflowGet Workflow returns information about a chosen Workflow.
- List category milestonesList Category Milestones returns a list of all Milestones with the Category.
- List category objectivesReturns a list of all Objectives with the Category.
- List custom fieldsRetrieves a list of all custom fields defined in the Shortcut API. This endpoint allows developers to fetch information about user-defined fields that have been added to extend the functionality of st
- List document epicsTool to retrieve all Epics related to a specific Document. Use when you need to understand which Epics are associated with a given document in Shortcut.
- List entity templatesList all the entity templates for the Workspace.
- List epic commentsGet a list of all Comments on an Epic.
- List epic documentsGet a list of all Documents related to this Epic.
- List epic healthsList the history of health statuses for the specified Epic, most recent first. Use when you need to track health status changes over time.
- List epic storiesGet a list of all Stories in an Epic.
- List filesList Files returns a list of all UploadedFiles in the workspace.
- List groupsA 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.
- List group storiesList the Stories assigned to the Group. (By default, limited to 1,000).
- List iterationsRetrieves a list of all iterations in the Shortcut project management system. Iterations represent specific time periods for planning and tracking work, allowing teams to organize their development cy
- List iteration storiesGet a list of all Stories in an Iteration.
- List label epicsList all of the Epics with the Label.
- List labelsList Labels returns a list of all Labels and their attributes.
- List label storiesList all of the Stories with the Label.
- List linked filesList Linked Files returns a list of all Linked-Files and their attributes.
- List membersReturns information about members of the Workspace.
- List members (slim)Returns minimal member data optimized for Korey integration. Use this when you need basic member information without full profile details. Returns all workspace members with disabled status indicated
- List objective epicsList all of the Epics within the Objective.
- List projectsList Projects returns a list of all Projects and their attributes.
- List repositoriesList Repositories returns a list of all Repositories and their attributes.
- List storiesList Stories returns a list of all Stories in a selected Project and their attributes.
- List story commentLists Comments associated with a Story
- List story sub-tasksTool to list all Sub-task Stories for a given parent Story. Use when you need to retrieve all sub-tasks associated with a specific story.
- List workflowsReturns a list of all Workflows in the Workspace.
- SearchSearch 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`
- Search epicsSearch 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 previou
- Search iterationsSearch 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 f
- Search milestonesSearch 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 f
- Search storiesSearch 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 p
- Search stories oldSearch Stories lets you search Stories based on desired parameters.
- Story historyRetrieves the complete history of changes for a specific story in the Shortcut project management system. This endpoint allows users to track all modifications, updates, and revisions made to a story
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 69 actions.
- Create docCreate Doc allows you to create a new document in Shortcut. Use when you need to create documentation, notes, or any written content. Supports markdown or HTML input.
- Create categoryCreate Category allows you to create a new Category in Shortcut.
- Create entity templateCreate a new entity template for the Workspace.
- Create epicCreate Epic allows you to create a new Epic in Shortcut.
- Create epic commentThis endpoint allows you to create a threaded Comment on an Epic.
- Create epic comment commentThis endpoint allows you to create a nested Comment reply to an existing Epic Comment.
- Create epic healthCreate a new health status for the specified Epic. Use when you need to set or update the health tracking status of an Epic.
- Create generic integrationTool to create a generic webhook integration in Shortcut. Use when you need to set up a webhook endpoint to receive Shortcut events.
- Create groupCreates a new group in the Shortcut system with customizable properties. This endpoint allows you to set up a group with a unique mention name, display name, optional description, and various customiz
- Create iterationThe CreateIteration endpoint allows you to create a new Iteration in Shortcut, which represents a time-boxed period for completing a set of stories or tasks. This endpoint is crucial for teams using A
- Create labelCreate Label allows you to create a new Label in Shortcut.
- Create linked fileCreate Linked File allows you to create a new Linked File in Shortcut.
Show all 69
- Create multiple storiesCreate 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 objectiveCreate Objective allows you to create a new Objective in Shortcut.
- Create projectCreate Project is used to create a new Shortcut Project.
- Create storyCreate 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 neith
- Create story commentCreate Comment allows you to create a Comment on any Story.
- Create story from templateCreate Story From Template is used to add a new story derived from a template to your Shortcut Workspace.
- Create story linkStory 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
- Create story reactionCreate a reaction to a story comment.
- Create taskCreate Task is used to create a new task in a Story.
- Delete categoryDelete Category can be used to delete any Category.
- Delete custom fieldDeletes a specific custom field from the Shortcut system using its unique public identifier. This endpoint should be used when you need to permanently remove a custom field that is no longer required
- Delete docPermanently deletes a Doc and its associated data from Shortcut. Requires admin access to the document. When a document is deleted, connected clients will be notified via Server-Sent Events (SSE). Use
- Delete entity templateDeletes a specific entity template from the Shortcut API. This endpoint should be used when you need to permanently remove a template that is no longer needed or is obsolete. It's important to note th
- Delete epicDelete Epic can be used to delete the Epic. The only required parameter is Epic ID.
- Delete epic commentThis endpoint allows you to delete a Comment from an Epic.
- Delete fileDelete File deletes a previously uploaded file.
- Delete generic integrationTool to delete a generic webhook integration from Shortcut. Use when you need to permanently remove a webhook integration that is no longer needed.
- Delete iterationDeletes a specific iteration from the Shortcut project management system. This endpoint should be used when you need to permanently remove an iteration and all its associated data from your project wo
- Delete labelDelete Label can be used to delete any Label.
- Delete linked fileDelete Linked File can be used to delete any previously attached Linked-File.
- Delete multiple storiesDelete Multiple Stories allows you to delete multiple archived stories at once.
- Delete objectiveDelete Objective can be used to delete any Objective.
- Delete projectDelete 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 resp
- Delete storyDelete Story can be used to delete any Story.
- Delete story commentDelete a Comment from any story.
- Delete story linkRemoves the relationship between the stories for the given Story Link.
- Delete story reactionDelete a reaction from any story comment.
- Delete taskDelete Task can be used to delete any previously created Task on a Story.
- Disable iterationsDisables Iterations for the current workspace
- Disable story templatesDisables the Story Template feature for the Workspace.
- Enable iterationsEnables Iterations for the current workspace
- Enable story templatesEnables the Story Template feature for the Workspace.
- Link document to epicTool to create a relationship between a Document and an Epic. Use when you need to link or associate documentation with an epic.
- Unlink comment thread from slackUnlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)
- Unlink document from epicTool to remove the relationship between a Document and an Epic. Use when you need to unlink a previously associated document from an epic.
- Unlink productboard from epicThis endpoint allows you to unlink a productboard epic.
- Update categoryUpdate 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.
- Update custom fieldUpdate 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 val
- Update DocTool to update an existing Doc's title and/or content. Use when you need to modify document properties. Supports markdown or HTML input via content_format parameter. SSE events notify connected users
- Update entity templateUpdate an entity template's name or its contents.
- Update epicUpdate 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.
- Update epic commentThis endpoint allows you to update a threaded Comment on an Epic.
- Update fileUpdate File updates the properties of an UploadedFile (but not its content).
- Update groupUpdates an existing group in the Shortcut workspace. This endpoint allows you to modify various properties of a group, including its name, description, color, members, and associated workflows. Use th
- Update health statusUpdate an existing health status by its ID. Use when you need to modify the health tracking status of an Epic or Objective.
- Update iterationThis endpoint allows you to update an existing iteration in Shortcut. It provides comprehensive control over various aspects of an iteration, including its metadata, associated members and groups, lab
- Update key resultUpdate Key Result allows updating a Key Result's name or initial, observed, or target values.
- Update labelUpdate 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.
- Update linked fileUpdated Linked File allows you to update properties of a previously attached Linked-File.
- Update multiple storiesUpdate Multiple Stories allows you to make changes to numerous stories at once.
- Update objectiveUpdate Objective can be used to update Objective properties.
- Update projectUpdate Project can be used to change properties of a Project.
- Update storyUpdate Story can be used to update Story properties.
- Update story commentUpdate Comment replaces the text of the existing Comment.
- Update story linkUpdates the stories and/or the relationship for the given Story Link.
- Update taskUpdate Task can be used to update Task properties.
- Upload filesUpload 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 UploadedFil
Changes wait in Needs you
Changes and sends in Shortcut are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Shortcut questions
Can an agent change data in Shortcut on its own?
Not by default. Changes and sends in Shortcut are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Shortcut?
This connector lists 67 read actions. Reads run at once, without waiting for approval.
How does Shortcut connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.