Skip to main content
Shortcut logo
  • Category: project management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 142
  • Triggers: 0
  • Slug: SHORTCUT
  • Version: 20261101_00

Tools

Slug: SHORTCUT_CREATE_CATEGORYCreate Category allows you to create a new Category in Shortcut.

Input Parameters

string
required
The name of the new Category.
string
The hex color to be displayed with the Category (for example, “#ff0000”).
string
This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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.

Input Parameters

string
required
The title for the new document.
string
required
The content for the new document.
string ("markdown" | "html")
Format of the content being sent. Defaults to ‘html’. If ‘markdown’, content will be converted to HTML for storage. Storage is always HTML; this parameter just tells us what format you’re sending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_ENTITY_TEMPLATECreate a new entity template for the Workspace.

Input Parameters

string
required
The name of the new entity template
string
The id of the user creating this template.
string
The name of the story.
array
An array of tasks to be populated by the template.
array
An array of labels to be populated by the template.
string
The due date of the story.
integer
The ID of the epic the to be populated.
integer
The numeric point estimate to be populated.
array
An array of the attached file IDs to be populated.
string
The ID of the group to be populated.
array
An array of UUIDs of the owners of this story.
string
The description of the story.
integer
The ID of the project the story belongs to.
string
The type of story (feature, bug, chore).
array
An array of UUIDs for any Members listed as Followers.
integer
The ID of the iteration the to be populated.
array
An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
array
An array of external links to be populated.
array
An array of the linked file IDs to be populated.
integer
The ID of the workflow state to be populated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_EPICCreate Epic allows you to create a new Epic in Shortcut.

Input Parameters

string
required
The Epic”s name.
string ("in progress" | "to do" | "done")
Deprecated The Epic”s state (to do, in progress, or done); will be ignored when epic_state_id is set.
array
An array of Labels attached to the Epic.
string
The Epic”s deadline.
string
Deprecated The ID of the group to associate with the epic. Use group_ids.
array
An array of UUIDS for Groups to which this Epic is related.
array
An array of UUIDs for any members you want to add as Owners on this new Epic.
string
Defaults to the time/date it is created but can be set to reflect another date.
string
Defaults to the time/date it is created but can be set to reflect another date.
string
The Epic”s description.
string
This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.
array
An array of UUIDs for any Members you want to add as Followers on this new Epic.
integer
Deprecated The ID of the Milestone this Epic is related to. Use objective_ids.
integer
The ID of the Epic State.
array
An array of IDs for Objectives to which this Epic is related.
string
The ID of the member that requested the epic.
string
The Epic”s planned start date.
string
A manual override for the time/date the Epic was started.
string
A manual override for the time/date the Epic was completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_EPIC_COMMENTThis endpoint allows you to create a threaded Comment on an Epic.

Input Parameters

string
required
The comment text.
string
The Member ID of the Comment”s author. Defaults to the user identified by the API token.
string
Defaults to the time/date the comment is created, but can be set to reflect another date.
string
Defaults to the time/date the comment is last updated, but can be set to reflect another date.
string
This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.
integer
required
The ID of the associated Epic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_EPIC_COMMENT_COMMENTThis endpoint allows you to create a nested Comment reply to an existing Epic Comment.

Input Parameters

string
required
The comment text.
string
The Member ID of the Comment”s author. Defaults to the user identified by the API token.
string
Defaults to the time/date the comment is created, but can be set to reflect another date.
string
Defaults to the time/date the comment is last updated, but can be set to reflect another date.
string
This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.
integer
required
The ID of the associated Epic.
integer
required
The ID of the parent Epic Comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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.

Input Parameters

string
The description of the Health status.
string ("At Risk" | "On Track" | "Off Track" | "No Health")
required
The health status of the Epic. One of ‘At Risk’, ‘On Track’, ‘Off Track’, or ‘No Health’.
integer
required
The unique ID of the Epic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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.

Input Parameters

string
Optional secret token for webhook signature verification (min 1, max 128 characters).
string
required
The webhook URL for the integration. Must be a valid HTTP or HTTPS URL (max 2048 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 customization options. Use this when you need to establish a new team, department, or any other collective within your Shortcut workspace. The created group can include members, associated workflows, and visual customizations like color and icon. This endpoint is particularly useful for organizing your Shortcut workspace structure, facilitating team collaboration, and streamlining workflow management. Note that while member and workflow associations can be set during creation, they can also be modified later using separate endpoints.

Input Parameters

string
required
The name of this Group.
string
The color you wish to use for the Group in the system.
string ("blue" | "purple" | "midnight-blue" | "orange" | "yellow-green" | "brass" | "gray" | "fuchsia" | "yellow" | "pink" | "sky-blue" | "green" | "red" | "black" | "slate" | "turquoise")
The color key you wish to use for the Group in the system.
array
The Member ids to add to this Group.
string
The description of the Group.
string
required
The mention name of this Group.
array
required
The Workflow ids to add to the Group. Required by the API.
string
The Icon id for the avatar of this Group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 Agile methodologies, enabling them to plan and track progress over specific time periods. Use this endpoint when setting up sprint cycles, planning releases, or organizing work into manageable timeframes. The endpoint requires essential information such as the Iteration’s name and date range, while also offering options to add followers, associate groups, and attach labels for better organization and tracking. It’s important to note that while multiple groups can be added via the API, the current web UI only displays one Group association. This endpoint should not be used for modifying existing Iterations; instead, use the dedicated update endpoint for such changes.

Input Parameters

string
required
The name of this Iteration.
array
An array of Labels attached to the Iteration.
string
required
The date this Iteration ends, e.g. 2019-07-01.
array
An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI.
string
required
The date this Iteration begins, e.g. 2019-07-01.
string
The description of the Iteration.
array
An array of UUIDs for any Members you want to add as Followers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_LABELCreate Label allows you to create a new Label in Shortcut.

Input Parameters

string
required
The name of the new Label.
string
The hex color to be displayed with the Label (for example, “#ff0000”).
string
The description of the new Label.
string
This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_LINKED_FILECreate Linked File allows you to create a new Linked File in Shortcut.

Input Parameters

string
required
The URL of linked file.
string
required
The name of the file.
integer
The filesize, if the integration provided it.
string ("google" | "url" | "dropbox" | "box" | "onedrive")
required
The integration type of the file (e.g. google, dropbox, box).
integer
The ID of the linked story.
string
The description of the file.
string
The UUID of the member that uploaded the file.
string
The content type of the image (e.g. txt/plain).
string
The URL of the thumbnail, if the integration provided it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_MILESTONE(Deprecated: Use ‘Create Objective’) Create Milestone allows you to create a new Milestone in Shortcut.

Input Parameters

string
required
The name of the Milestone.
string ("in progress" | "to do" | "done")
The workflow state that the Milestone is in.
array
An array of IDs of Categories attached to the Milestone.
string
The Milestone”s description.
string
A manual override for the time/date the Milestone was started.
string
A manual override for the time/date the Milestone was completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_MULTIPLE_STORIESCreate Multiple Stories allows you to create multiple stories in a single request using the same syntax as Create Story.

Input Parameters

array
required
An array of stories to be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_OBJECTIVECreate Objective allows you to create a new Objective in Shortcut.

Input Parameters

string
required
The name of the Objective.
string ("in progress" | "to do" | "done")
The workflow state that the Objective is in.
array
An array of IDs of Categories attached to the Objective.
string
The Objective”s description.
string
A manual override for the time/date the Objective was started.
string
A manual override for the time/date the Objective was completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_PROJECTCreate Project is used to create a new Shortcut Project.

Input Parameters

string
required
The name of the Project.
string
The color you wish to use for the Project in the system.
integer
required
The ID of the team the project belongs to.
string
Defaults to the time/date it is created but can be set to reflect another date.
string
The date at which the Project was started.
string
Defaults to the time/date it is created but can be set to reflect another date.
string
The Project description.
string
This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here.
string
The Project abbreviation used in Story summaries. Should be kept to 3 characters at most.
array
An array of UUIDs for any members you want to add as Owners on this new Epic.
integer
The number of weeks per iteration in this Project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_STORYCreates a story in the Shortcut workspace. Provide at least one of workflow_state_id or project_id; workflow_state_id is recommended.

Input Parameters

string
required
The name of the story.
array
An array of tasks connected to the story.
array
An array of labels attached to the story.
integer
The ID of the epic the story belongs to.
string ("last" | "first")
One of “first” or “last”. This can be used to move the given story to the first or last position in the workflow state.
boolean
Controls the story”s archived state.
array
An array of comments to add to the story.
string
The due date of the story.
integer
The numeric point estimate of the story. Can also be null, which means unestimated.
array
An array of IDs of files attached to the story.
string
The id of the group to associate with this story.
array
An array of UUIDs of the owners of this story.
array
An array of sub tasks to create.
string
The time/date the Story was created.
integer
The ID of the project the story belongs to. At least one of project_id or workflow_state_id is required.
string ("feature" | "chore" | "bug")
The type of story (feature, bug, chore).
string
The time/date the Story was updated.
string
The description of the story.
string
This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.
array
An array of story links attached to the story.
array
An array of UUIDs of the followers of this story.
integer
The ID of the iteration the story belongs to.
array
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
An array of External Links associated with this story.
integer
Given this story was converted from a task in another story, this is the original task ID that was converted to this story.
array
An array of IDs of linked files attached to the story.
string
The ID of the member that requested the story.
string
The id of the story template used to create this story, if applicable. This is just an association; no content from the story template is inherited by the story simply by setting this field.
integer
The ID of the workflow state the story will be in. At least one of workflow_state_id or project_id is required.
string
A manual override for the time/date the Story was started.
string
A manual override for the time/date the Story was completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_STORY_COMMENTCreate Comment allows you to create a Comment on any Story.

Input Parameters

string
required
The comment text.
string
The Member ID of the Comment”s author. Defaults to the user identified by the API token.
integer
The ID of the Comment that this comment is threaded under.
string
Defaults to the time/date the comment is created, but can be set to reflect another date.
string
Defaults to the time/date the comment is last updated, but can be set to reflect another date.
string
This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.
integer
required
The ID of the Story that the Comment is in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_STORY_FROM_TEMPLATECreate Story From Template is used to add a new story derived from a template to your Shortcut Workspace.

Input Parameters

string
The name of the story. Must be provided if the template does not provide a name.
array
An array of tasks connected to the story.
array
An array of labels attached to the story.
integer
The ID of the epic the story belongs to.
string ("last" | "first")
One of “first” or “last”. This can be used to move the given story to the first or last position in the workflow state.
boolean
Controls the story”s archived state.
array
An array of comments to add to the story.
string
The due date of the story.
integer
The numeric point estimate of the story. Can also be null, which means unestimated.
array
An array of IDs of files attached to the story.
string
The id of the group to associate with this story.
array
An array of UUIDs of the owners of this story.
array
An array of sub tasks to create.
string
The time/date the Story was created.
array
An array of labels attached to the story in addition to the labels provided by the template. Cannot be used in conjunction with labels.
integer
The ID of the project the story belongs to.
string ("feature" | "chore" | "bug")
The type of story (feature, bug, chore).
string
The time/date the Story was updated.
string
The description of the story.
string
This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.
array
An array of story links attached to the story.
array
An array of IDs of files attached to the story in addition to files from the template. Cannot be used in conjunction with file_ids.
array
An array of UUIDs of the followers of this story.
integer
The ID of the iteration the story belongs to.
array
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
array
An array of labels to remove from the labels provided by the template. Cannot be used in conjunction with labels.
array
The UUIDs of the new owners to be added in addition to owners from the template. Cannot be used in conjunction with owners.
An array of External Links associated with this story.
integer
Given this story was converted from a task in another story, this is the original task ID that was converted to this story.
array
An array of IDs of files removed from files from the template. Cannot be used in conjunction with file_ids.
array
An array of IDs of linked files attached to the story.
string
The ID of the member that requested the story.
array
The UUIDs of the new followers to be added in addition to followers from the template. Cannot be used in conjunction with follower_ids.
array
The UUIDs of the new owners to be removed from owners from the template. Cannot be used in conjunction with owners.
array
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. These will be added to any fields provided by the template. Cannot be used in conjunction with custom_fields.
string
required
The id of the story template used to create this story.
integer
The ID of the workflow state the story will be in.
An array of External Links associated with this story. These will be added to any links provided by the template. Cannot be used in conjunction with external_links.
array
The UUIDs of the new followers to be removed from followers from the template. Cannot be used in conjunction with follower_ids.
array
An array of IDs of linked files attached to the story in addition to files from the template. Cannot be used in conjunction with linked_files.
string
A manual override for the time/date the Story was started.
array
A map specifying a CustomField ID. These will be removed from any fields provided by the template. Cannot be used in conjunction with custom_fields.
string
A manual override for the time/date the Story was completed.
An array of External Links associated with this story. These will be removed from any links provided by the template. Cannot be used in conjunction with external_links.
array
An array of IDs of linked files removed from files from the template. Cannot be used in conjunction with linked_files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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. 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”

Input Parameters

string ("blocks" | "duplicates" | "relates to")
required
The type of link.
integer
required
The ID of the object Story.
integer
required
The ID of the subject Story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_STORY_REACTIONCreate a reaction to a story comment.

Input Parameters

string
required
The emoji short-code to add / remove. E.g. :thumbsup::skin-tone-4:.
integer
required
The ID of the Story that the Comment is in.
integer
required
The ID of the Comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_CREATE_TASKCreate Task is used to create a new task in a Story.

Input Parameters

boolean
True/false boolean indicating whether the Task is completed. Defaults to false.
array
An array of UUIDs for any members you want to add as Owners on this new Task.
string
Defaults to the time/date the Task is created but can be set to reflect another creation time/date.
string
Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date.
string
required
The Task description.
string
This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here.
integer
required
The ID of the Story that the Task will be in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_CATEGORYDelete Category can be used to delete any Category.

Input Parameters

integer
required
The unique ID of the Category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 in your workflows or project structure. It’s important to note that this operation is irreversible, and once a custom field is deleted, all data associated with it will be lost. Use this endpoint with caution, ensuring that the custom field is no longer needed and that its deletion won’t negatively impact any existing processes or data integrity within your Shortcut instance.

Input Parameters

string
required
The unique ID of the CustomField.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 this action when you need to remove a document completely from the system. Be cautious as this operation is irreversible.

Input Parameters

string
required
The Doc’s public ID (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 that this operation cannot be undone, so it should be used with caution. The deletion is performed on a single template identified by its public ID, adhering to the best practice of controlling deletion on a per-resource basis. This endpoint is part of the API v3, which may include enhanced features or changes compared to previous versions.

Input Parameters

string
required
The unique ID of the entity template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_EPICDelete Epic can be used to delete the Epic. The only required parameter is Epic ID.

Input Parameters

integer
required
The unique ID of the Epic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_EPIC_COMMENTThis endpoint allows you to delete a Comment from an Epic.

Input Parameters

integer
required
The ID of the associated Epic.
integer
required
The ID of the Comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_FILEDelete File deletes a previously uploaded file.

Input Parameters

integer
required
The File’s unique ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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.

Input Parameters

integer
required
The unique ID of the Generic Integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 workflow. It’s particularly useful for cleaning up completed or cancelled iterations that are no longer needed. Be cautious when using this endpoint, as the deletion is irreversible and will remove all data associated with the specified iteration. Ensure you have the correct iteration ID before proceeding with the deletion to avoid unintended data loss.

Input Parameters

integer
required
The unique ID of the Iteration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_LABELDelete Label can be used to delete any Label.

Input Parameters

integer
required
The unique ID of the Label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_LINKED_FILEDelete Linked File can be used to delete any previously attached Linked-File.

Input Parameters

integer
required
The unique identifier of the linked file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_MILESTONE(Deprecated: Use ‘Delete Objective’) Delete Milestone can be used to delete any Milestone.

Input Parameters

integer
required
The ID of the Milestone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_MULTIPLE_STORIESDelete Multiple Stories allows you to delete multiple archived stories at once.

Input Parameters

array
required
An array of IDs of Stories to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_OBJECTIVEDelete Objective can be used to delete any Objective.

Input Parameters

integer
required
The ID of the Objective.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 response.

Input Parameters

integer
required
The unique ID of the Project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_STORYDelete Story can be used to delete any Story.

Input Parameters

integer
required
The ID of the Story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_STORY_COMMENTDelete a Comment from any story.

Input Parameters

integer
required
The ID of the Story that the Comment is in.
integer
required
The ID of the Comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_STORY_LINKRemoves the relationship between the stories for the given Story Link.

Input Parameters

integer
required
The unique ID of the Story Link.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_STORY_REACTIONDelete a reaction from any story comment.

Input Parameters

string
required
The emoji short-code to add / remove. E.g. :thumbsup::skin-tone-4:.
integer
required
The ID of the Story that the Comment is in.
integer
required
The ID of the Comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DELETE_TASKDelete Task can be used to delete any previously created Task on a Story.

Input Parameters

integer
required
The unique ID of the Task.
integer
required
The unique ID of the Story this Task is associated with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DISABLE_ITERATIONSDisables Iterations for the current workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_DISABLE_STORY_TEMPLATESDisables the Story Template feature for the Workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_ENABLE_ITERATIONSEnables Iterations for the current workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_ENABLE_STORY_TEMPLATESEnables the Story Template feature for the Workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_CATEGORYGet Category returns information about the selected Category.

Input Parameters

integer
required
The unique ID of the Category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_CURRENT_MEMBER_INFOReturns information about the authenticated member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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, which can include its name, type, possible values, and any other associated metadata. It’s particularly useful when you need to inspect or validate a custom field’s settings programmatically, or when integrating custom field data into external systems. The endpoint should be used when detailed information about a single custom field is required, rather than for bulk operations or listing all custom fields. Note that this endpoint only provides read access to custom field data and cannot be used to modify the custom field.

Input Parameters

string
required
The unique ID of the CustomField.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_DOCGet Doc returns information about a chosen Doc by its public ID. Use content_format=html to include HTML content in the response.

Input Parameters

string ("markdown" | "html")
Format of the content to return.
string
required
The Doc’s public ID (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_ENTITY_TEMPLATEGet Entity Template returns information about a given entity template.

Input Parameters

string
required
The unique ID of the entity template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_EPICGet Epic returns information about the selected Epic.

Input Parameters

integer
required
The unique ID of the Epic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_EPIC_COMMENTThis endpoint returns information about the selected Epic Comment.

Input Parameters

integer
required
The ID of the associated Epic.
integer
required
The ID of the Comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_EPIC_HEALTHGet the current health status for the specified Epic. Use when you need to check the health status of an Epic.

Input Parameters

integer
required
The unique ID of the Epic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_EPIC_WORKFLOWReturns the Epic Workflow for the Workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_FILEGet File returns information about the selected UploadedFile.

Input Parameters

integer
required
The File’s unique ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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.

Input Parameters

integer
required
The unique ID of the Generic Integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 its name, type, and associated metadata. It’s particularly useful when you need to access or verify group details programmatically, such as during workflow automations or when building integrations that involve group management. The endpoint provides more granular control and information compared to what’s available through the web application, making it valuable for advanced group-related operations and data analysis within your Shortcut projects.

Input Parameters

string
required
The unique ID of the Group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_ITERATIONRetrieve details of a specific Shortcut iteration by ID, including its name, status, dates, labels and progress metrics.

Input Parameters

integer
required
The unique ID of the Iteration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_KEY_RESULTGet Key Result returns information about a chosen Key Result.

Input Parameters

string
required
The ID of the Key Result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_LABELGet Label returns information about the selected Label.

Input Parameters

integer
required
The unique ID of the Label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_LINKED_FILEGet File returns information about the selected Linked File.

Input Parameters

integer
required
The unique identifier of the linked file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_MEMBERReturns information about a Member.

Input Parameters

string
The unique ID of the Organization to limit the lookup to.
string
required
The Member”s unique ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_MILESTONE(Deprecated: Use ‘Get Objective’) Get Milestone returns information about a chosen Milestone.

Input Parameters

integer
required
The ID of the Milestone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_OBJECTIVEGet Objective returns information about a chosen Objective.

Input Parameters

integer
required
The ID of the Objective.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_PROJECTGet Project returns information about the selected Project.

Input Parameters

integer
required
The unique ID of the Project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_REPOSITORYGet Repository returns information about the selected Repository.

Input Parameters

integer
required
The unique ID of the Repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_STORYGet Story returns information about a chosen Story.

Input Parameters

integer
required
The ID of the Story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_STORY_COMMENTGet Comment is used to get Comment information.

Input Parameters

integer
required
The ID of the Story that the Comment is in.
integer
required
The ID of the Comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_STORY_LINKReturns the stories and their relationship for the given Story Link.

Input Parameters

integer
required
The unique ID of the Story Link.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_TASKReturns information about a chosen Task.

Input Parameters

integer
required
The unique ID of the Task.
integer
required
The unique ID of the Story this Task is associated with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_GET_WORKFLOWGet Workflow returns information about a chosen Workflow.

Input Parameters

integer
required
The ID of the Workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_CATEGORIESList Categories returns a list of all Categories and their attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_CATEGORY_MILESTONESList Category Milestones returns a list of all Milestones with the Category.

Input Parameters

integer
required
The unique ID of the Category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_CATEGORY_OBJECTIVESReturns a list of all Objectives with the Category.

Input Parameters

integer
required
The unique ID of the Category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 standard fields in integrations. It’s particularly useful when you need to understand the structure and types of custom data being used across the system. The endpoint returns details about each custom field, which may include their identifiers, names, types, and any associated metadata. Use this endpoint when you need to inventory existing custom fields, prepare for data migrations, or dynamically adjust your application’s data model to accommodate custom fields. Note that this endpoint does not create, modify, or delete custom fields; it’s purely for retrieval of existing custom field definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_DOCSTool to list Docs that the current user can read. Use when you need to retrieve all accessible documentation in the Shortcut workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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.

Input Parameters

string
required
The public ID of the Document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_ENTITY_TEMPLATESList all the entity templates for the Workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_EPIC_COMMENTSGet a list of all Comments on an Epic.

Input Parameters

integer
required
The unique ID of the Epic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_EPIC_DOCUMENTSGet a list of all Documents related to this Epic.

Input Parameters

integer
required
The unique ID of the Epic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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.

Input Parameters

integer
required
The unique ID of the Epic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_EPICSList Epics returns a list of all Epics and their attributes.

Input Parameters

boolean
A true/false boolean indicating whether to return Epics with their descriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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.

Input Parameters

integer
The page number to return, starting with 1. Defaults to 1.
integer
The number of Epics to return per page. Minimum 1, maximum 250, default 10.
boolean
A true/false boolean indicating whether to return Epics with their descriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_EPIC_STORIESGet a list of all Stories in an Epic.

Input Parameters

integer
required
The unique ID of the Epic.
boolean
A true/false boolean indicating whether to return Stories with their descriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_FILESList Files returns a list of all UploadedFiles in the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_GROUPSList groups in the Shortcut workspace. Groups correspond to Teams, which can be associated with Stories, Epics, and Iterations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_GROUP_STORIESList the Stories assigned to the Group. (By default, limited to 1,000).

Input Parameters

integer
The maximum number of results to return. (Defaults to 1000, max 1000)
integer
The offset at which to begin returning results. (Defaults to 0)
string
required
The unique ID of the Group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 cycles. This endpoint provides comprehensive information about each iteration, including its name, start and end dates, status, and associated stories or tasks. Use this endpoint when you need an overview of all iterations for project planning, progress tracking, or reporting purposes. It’s particularly useful for analyzing past performance, planning future sprints, or getting a high-level view of the project timeline. Note that the response may be paginated for projects with a large number of iterations, and you might need to make multiple requests to retrieve the full dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_ITERATION_STORIESGet a list of all Stories in an Iteration.

Input Parameters

boolean
A true/false boolean indicating whether to return Stories with their descriptions.
integer
required
The unique ID of the Iteration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_LABEL_EPICSList all of the Epics with the Label.

Input Parameters

integer
required
The unique ID of the Label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_LABELSList Labels returns a list of all Labels and their attributes.

Input Parameters

boolean
A true/false boolean indicating if the slim versions of the Label should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_LABEL_STORIESList all of the Stories with the Label.

Input Parameters

integer
required
The unique ID of the Label.
boolean
A true/false boolean indicating whether to return Stories with their descriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_LINKED_FILESList Linked Files returns a list of all Linked-Files and their attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_MEMBERSReturns information about members of the Workspace.

Input Parameters

string
The unique ID of the Organization to limit the list to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_MEMBERS_SLIMReturns 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 in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_MILESTONE_EPICS(Deprecated: Use ‘List Objective Epics’) List all of the Epics within the Milestone.

Input Parameters

integer
required
The ID of the Milestone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_MILESTONES(Deprecated: Use ‘List Objectives’) List Milestones returns a list of all Milestones and their attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_OBJECTIVE_EPICSList all of the Epics within the Objective.

Input Parameters

integer
required
The ID of the Objective.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_OBJECTIVESList Objectives returns a list of all Objectives and their attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_PROJECTSList Projects returns a list of all Projects and their attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_REPOSITORIESList Repositories returns a list of all Repositories and their attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_STORIESList Stories returns a list of all Stories in a selected Project and their attributes.

Input Parameters

integer
required
The unique ID of the Project.
boolean
A true/false boolean indicating whether to return Stories with their descriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_STORY_COMMENTLists Comments associated with a Story

Input Parameters

integer
required
The ID of the Story that the Comment is in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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.

Input Parameters

integer
required
The ID of the Story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_LIST_WORKFLOWSReturns a list of all Workflows in the Workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_SEARCHSearch Shortcut entities using a query and optional entity-type filters; stories and epics are searched by default. Choose full or slim result detail and a page size from 1 to 25, and use the previous response’s next value to request another page.

Input Parameters

string
The next page token.
string
required
See our help center article on search operators
string ("full" | "slim")
The amount of detail included in each result item. “full” will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. “slim” omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is “full”.
integer
The number of search results to include in a page. Minimum of 1 and maximum of 25.
array
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_SEARCH_DOCUMENTSSearch Shortcut documents by fuzzy title, with optional archived, created-by-me, and followed-by-me filters. A title is required.

Input Parameters

string
The next page token.
string
required
Search text to match against document titles. Supports fuzzy matching. Required.
boolean
When true, find archived documents. When false, find non-archived documents.
integer
The number of search results to include in a page. Minimum of 1 and maximum of 250.
boolean
When true, find documents created by the current user. When false, find documents NOT created by current user.
boolean
When true, find documents that the current user is following. When false, find documents NOT followed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_SEARCH_EPICSSearch Epics using a query and optional pagination and detail parameters. Pass the previous response’s next value to request the next page.

Input Parameters

string
The next page token.
string
required
See our help center article on search operators
string ("full" | "slim")
The amount of detail included in each result item. “full” will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. “slim” omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is “full”.
integer
The number of search results to include in a page. Minimum of 1 and maximum of 25.
array
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_SEARCH_ITERATIONSSearch Shortcut iterations using a query, with optional result detail and pagination. Supply the previous response’s next value to request the next page.

Input Parameters

string
The next page token.
string
required
See our help center article on search operators
string ("full" | "slim")
The amount of detail included in each result item. “full” will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. “slim” omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is “full”.
integer
The number of search results to include in a page. Minimum of 1 and maximum of 25.
array
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_SEARCH_MILESTONESSearch milestones using a query and optional search parameters. Supply the previous response’s next value to request another page.

Input Parameters

string
The next page token.
string
required
See our help center article on search operators
string ("full" | "slim")
The amount of detail included in each result item. “full” will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. “slim” omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is “full”.
integer
The number of search results to include in a page. Minimum of 1 and maximum of 25.
array
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_SEARCH_OBJECTIVESSearch Shortcut objectives using a query and optional search parameters. Pass the previous response’s next value as the next parameter to request another page.

Input Parameters

string
The next page token.
string
required
See our help center article on search operators
string ("full" | "slim")
The amount of detail included in each result item. “full” will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. “slim” omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is “full”.
integer
The number of search results to include in a page. Minimum of 1 and maximum of 25.
array
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 previous response can be used as the path and query string for the next page to ensure stable ordering.

Input Parameters

string
The URL path and query string returned in the previous response’s next field. Pass it back unchanged.
string
required
See our help center article on search operators
string ("full" | "slim")
The amount of detail included in each result item. “full” will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. “slim” omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is “full”.
integer
The number of search results to include in a page. Minimum of 1 and maximum of 25.
array
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_SEARCH_STORIES_OLDSearch Stories lets you search Stories based on desired parameters.

Input Parameters

integer
The Epic IDs that may be associated with the Stories.
boolean
A true/false boolean indicating whether the Story is in archived state.
array
The Epic IDs that may be associated with the Stories.
integer
The number of estimate points associate with the Stories.
string
The Group ID that is associated with the Stories
string
An array of UUIDs for any Users who may be Owners of the Stories.
array
The Group IDs that are associated with the Stories
array
The Label IDs that may be associated with the Stories.
array
An array of UUIDs for any Users who may be Owners of the Stories.
string
The name of any associated Labels.
integer
The IDs for the Projects the Stories may be assigned to.
string ("feature" | "chore" | "bug")
The type of Stories that you want returned.
string
An ID or URL that references an external resource. Useful during imports.
array
The IDs for the Projects the Stories may be assigned to.
string
Stories should have a deadline on or before this date.
integer
The Iteration ID that may be associated with the Stories.
array
The Iteration IDs that may be associated with the Stories.
string
Stories should have been created on or before this date.
string
Stories should have a deadline on or after this date.
string
Stories should have been updated on or before this date.
string
The UUID of any Users who may have requested the Stories.
string
Stories should have been completed on or before this date.
string
Stories should have been created on or after this date.
string
Stories should have been updated on or after this date.
integer
The unique IDs of the specific Workflow States that the Stories should be in.
string
Stories should have been completed on or after this date.
boolean
Whether to include the story description in the response.
array
The type of Workflow State the Stories may be in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 over time, providing a comprehensive timeline of its evolution. It’s particularly useful for project managers, team members, and stakeholders who need to understand how a story has changed, who made the changes, and when they occurred. The endpoint returns a chronological list of all events and modifications associated with the specified story, helping teams maintain transparency and accountability in their project workflows. Note that this endpoint focuses solely on the history of a single story and does not provide information about related stories or overall project status.

Input Parameters

integer
required
The ID of the Story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_CATEGORYUpdates a Shortcut Category’s name, color, or archived status. Naming a Category something that already exists returns a 422 response.

Input Parameters

string
The new name of the Category.
string
The hex color to be displayed with the Category (for example, “#ff0000”).
boolean
A true/false boolean indicating if the Category has been archived.
integer
required
The unique ID of the Category you wish to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 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’}).

Input Parameters

string
A collection of objects representing reporting periods for years.
array
A collection of EnumValue objects representing the values in the domain of some Custom Field.
boolean
Indicates whether the Field is enabled for the Workspace. Only enabled fields can be applied to Stories.
string
The ID of the CustomField we want to move this CustomField after.
string
The ID of the CustomField we want to move this CustomField before.
string
A description of the purpose of this field.
string
A frontend-controlled string that represents the icon for this custom field.
string
required
The unique ID of the CustomField.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 to refresh; if no users are connected, CKEditor cache is flushed.

Input Parameters

string
The new title for the document
string
The new content for the document.
string ("markdown" | "html")
Format of content. For input: specifies format of provided content (defaults to ‘html’). For output: controls response format - ‘markdown’ (default) or ‘html’ to include HTML content.
string
required
The Doc’s public ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_ENTITY_TEMPLATEUpdate an entity template’s name or its contents.

Input Parameters

string
The updated template name.
string
The name of the story.
array
An array of tasks to be populated by the template.
array
An array of labels to be populated by the template.
string
The due date of the story.
integer
The ID of the epic the to be populated.
integer
The numeric point estimate to be populated.
array
An array of the attached file IDs to be populated.
string
The ID of the group to be populated.
array
An array of UUIDs of the owners of this story.
string
required
The unique ID of the template to be updated.
string
The description of the story.
integer
The ID of the project the story belongs to.
string
The type of story (feature, bug, chore).
array
An array of UUIDs for any Members listed as Followers.
integer
The ID of the iteration the to be populated.
array
An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
array
An array of external links to be populated.
array
An array of the linked file IDs to be populated.
integer
The ID of the workflow state to be populated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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.

Input Parameters

string
The Epic”s name.
string ("in progress" | "to do" | "done")
Deprecated The Epic”s state (to do, in progress, or done); will be ignored when epic_state_id is set.
array
An array of Labels attached to the Epic.
integer
The ID of the Epic we want to move this Epic after.
boolean
A true/false boolean indicating whether the Epic is in archived state.
string
The Epic”s deadline.
string
Deprecated The ID of the group to associate with the epic. Use group_ids.
integer
The ID of the Epic we want to move this Epic before.
array
An array of UUIDS for Groups to which this Epic is related.
array
An array of UUIDs for any members you want to add as Owners on this Epic.
string
The Epic”s description.
string
This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.
array
An array of UUIDs for any Members you want to add as Followers on this Epic.
integer
Deprecated The ID of the Milestone this Epic is related to. Use objective_ids.
integer
The ID of the Epic State.
array
An array of IDs for Objectives to which this Epic is related.
string
The ID of the member that requested the epic.
integer
required
The unique ID of the Epic.
string
The Epic”s planned start date.
string
A manual override for the time/date the Epic was started.
string
A manual override for the time/date the Epic was completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_EPIC_COMMENTUpdate the text of a threaded Comment on an Epic.

Input Parameters

string
required
The updated comment text.
integer
required
The ID of the associated Epic.
integer
required
The ID of the Comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_FILEUpdate File updates the properties of an UploadedFile (but not its content).

Input Parameters

string
The name of the file.
string
The time/date that the file was uploaded.
string
The time/date that the file was last updated.
string
The description of the file.
string
An additional ID that you may wish to assign to the file.
string
The unique ID assigned to the Member who uploaded the file to Shortcut.
integer
required
The unique ID assigned to the file in Shortcut.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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 this when you need to change group details, add or remove members, or update the group’s visual representation. It’s particularly useful for team reorganizations, project changes, or general maintenance of your Shortcut workspace structure. Note that while many fields are optional, you should include any fields you wish to modify; omitted fields will retain their current values.

Input Parameters

string
The name of this Group.
string
The color you wish to use for the Group in the system.
boolean
Whether or not this Group is archived.
string ("blue" | "purple" | "midnight-blue" | "orange" | "yellow-green" | "brass" | "gray" | "fuchsia" | "yellow" | "pink" | "sky-blue" | "green" | "red" | "black" | "slate" | "turquoise")
The color key you wish to use for the Group in the system.
array
The Member ids to add to this Group.
string
The description of this Group.
string
The mention name of this Group.
array
The Workflow ids to add to the Group.
string
The Icon id for the avatar of this Group.
string
required
The unique ID of the Group.
integer
The ID of the default workflow for stories created in this group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_HEALTHUpdate an existing health status by its ID. Use when you need to modify the health tracking status of an Epic or Objective.

Input Parameters

string
The description of the Health status.
string ("At Risk" | "On Track" | "Off Track" | "No Health")
Health status of the Epic or Objective.
string
required
The unique ID of the Health record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_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, labels, and timeframe. Use this endpoint when you need to modify any details of an ongoing or upcoming iteration, such as adjusting dates, adding followers, or updating labels. The endpoint is particularly useful for project managers or team leads who need to refine iteration details as the project progresses. Note that while you can update multiple aspects of an iteration in a single call, only the fields you include in the request will be modified; omitted fields will retain their current values.

Input Parameters

string
The name of this Iteration
array
An array of Labels attached to the Iteration.
string
The date this Iteration ends, e.g. 2019-07-05.
array
An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI.
string
The date this Iteration begins, e.g. 2019-07-01
string
The description of the Iteration.
array
An array of UUIDs for any Members you want to add as Followers.
integer
required
The unique ID of the Iteration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_KEY_RESULTUpdate Key Result allows updating a Key Result’s name or initial, observed, or target values.

Input Parameters

string
The name of the Key Result.
string
required
The ID of the Key Result.
boolean
The boolean value.
string
The numeric value, as a decimal string. No more than two decimal places are allowed.
boolean
The boolean value.
string
The numeric value, as a decimal string. No more than two decimal places are allowed.
boolean
The boolean value.
string
The numeric value, as a decimal string. No more than two decimal places are allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_LABELUpdate a Shortcut label’s name, description, color, or archived status. Attempting to use an existing label name may return a 422 response.

Input Parameters

string
The new name of the label.
string
The hex color to be displayed with the Label (for example, “#ff0000”).
boolean
A true/false boolean indicating if the Label has been archived.
string
The new description of the label.
integer
required
The unique ID of the Label you wish to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_LINKED_FILEUpdated Linked File allows you to update properties of a previously attached Linked-File.

Input Parameters

string
The URL of linked file.
string
The name of the file.
integer
The filesize, if the integration provided it.
string ("google" | "url" | "dropbox" | "box" | "onedrive")
The integration type of the file (e.g. google, dropbox, box).
integer
The ID of the linked story.
string
The description of the file.
string
The UUID of the member that uploaded the file.
string
The URL of the thumbnail, if the integration provided it.
integer
required
The unique identifier of the linked file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_MILESTONE(Deprecated: Use ‘Update Objective’) Update Milestone can be used to update Milestone properties.

Input Parameters

string
The name of the Milestone.
string ("in progress" | "to do" | "done")
The workflow state that the Milestone is in.
integer
The ID of the Milestone we want to move this Milestone after.
boolean
A boolean indicating whether the Milestone is archived or not
integer
The ID of the Milestone we want to move this Milestone before.
array
An array of IDs of Categories attached to the Milestone.
string
The Milestone”s description.
string
A manual override for the time/date the Milestone was started.
string
A manual override for the time/date the Milestone was completed.
integer
required
The ID of the Milestone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_MULTIPLE_STORIESUpdate Multiple Stories allows you to make changes to numerous stories at once.

Input Parameters

integer
The ID of the epic the story belongs to.
string ("last" | "first")
One of “first” or “last”. This can be used to move the given story to the first or last position in the workflow state.
integer
The ID of the story that the stories are to be moved below.
boolean
If the Stories should be archived or not.
string
The due date of the story.
integer
The numeric point estimate of the story. Can also be null, which means unestimated.
string
The Id of the Group the Stories should belong to.
integer
The ID of the story that the stories are to be moved before.
array
required
The Ids of the Stories you wish to update.
array
An array of labels to be added.
integer
The ID of the Project the Stories should belong to.
string ("feature" | "chore" | "bug")
The type of story (feature, bug, chore).
integer
The ID of the iteration the story belongs to.
array
An array of labels to be removed.
array
The UUIDs of the new owners to be added.
An array of External Links associated with this story.
string
The ID of the member that requested the story.
array
The UUIDs of the new followers to be added.
array
The UUIDs of the owners to be removed.
array
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
integer
The ID of the workflow state to put the stories in.
array
The UUIDs of the followers to be removed.
array
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_OBJECTIVEUpdate Objective can be used to update Objective properties.

Input Parameters

string
The name of the Objective.
string ("in progress" | "to do" | "done")
The workflow state that the Objective is in.
integer
The ID of the Objective we want to move this Objective after.
boolean
A boolean indicating whether the Objective is archived or not
integer
The ID of the Objective we want to move this Objective before.
array
An array of IDs of Categories attached to the Objective.
string
The Objective”s description.
string
A manual override for the time/date the Objective was started.
string
A manual override for the time/date the Objective was completed.
integer
required
The ID of the Objective.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_PROJECTUpdate Project can be used to change properties of a Project.

Input Parameters

string
The Project”s name.
string
The color that represents the Project in the UI.
integer
The ID of the team the project belongs to.
boolean
A true/false boolean indicating whether the Story is in archived state.
string
The Project”s description.
string
The Project abbreviation used in Story summaries. Should be kept to 3 characters at most.
array
An array of UUIDs for any Members you want to add as Followers.
boolean
Configuration to enable or disable thermometers in the Story summary.
integer
The number of days before the thermometer appears in the Story summary.
integer
required
The unique ID of the Project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_STORYUpdate Story can be used to update Story properties.

Input Parameters

string
The title of the story.
array
An array of labels attached to the story.
integer
The ID of the epic the story belongs to.
string ("last" | "first")
One of “first” or “last”. This can be used to move the given story to the first or last position in the workflow state.
integer
The ID of the story we want to move this story after.
boolean
True if the story is archived, otherwise false.
string
The due date of the story.
integer
The numeric point estimate of the story. Can also be null, which means unestimated.
array
An array of IDs of files attached to the story.
string
The ID of the group to associate with this story
integer
The ID of the story we want to move this story before.
array
An array of UUIDs of the owners of this story.
array
An array of IDs of Branches attached to the story.
array
An array of IDs of Commits attached to the story.
integer
The ID of the project the story belongs to.
string ("feature" | "chore" | "bug")
The type of story (feature, bug, chore).
string
The description of the story.
array
An array of UUIDs of the followers of this story.
integer
The ID of the iteration the story belongs to.
array
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
An array of External Links associated with this story.
array
An array of IDs of linked files attached to the story.
string
The ID of the member that requested the story.
array
An array of IDs of Pull/Merge Requests attached to the story.
integer
required
The unique identifier of this story.
integer
The ID of the workflow state to put the story in.
string
A manual override for the time/date the Story was started.
string
A manual override for the time/date the Story was completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_STORY_COMMENTUpdate Comment replaces the text of the existing Comment.

Input Parameters

string
required
The updated comment text.
integer
required
The ID of the Story that the Comment is in.
integer
required
The ID of the Comment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_STORY_LINKUpdates the stories and/or the relationship for the given Story Link.

Input Parameters

string ("blocks" | "duplicates" | "relates to")
The type of link.
integer
The ID of the object Story.
integer
The ID of the subject Story.
integer
required
The unique ID of the Story Link.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPDATE_TASKUpdate Task can be used to update Task properties.

Input Parameters

integer
Move task after this task ID.
boolean
A true/false boolean indicating whether the task is complete.
integer
Move task before this task ID.
array
An array of UUIDs of the owners of this story.
string
The Task”s description.
integer
required
The unique identifier of the Task you wish to update.
integer
required
The unique identifier of the parent Story.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTCUT_UPLOAD_FILESUploads up to four files, optionally associating them with a story. Supply at least one file; the tool builds the multipart upload using each file’s name.

Input Parameters

object
A file upload. At least one is required. Provide as FileType with ‘name’ and ‘content’ (base64 encoded).
object
Optional additional file. Provide as FileType with ‘name’ and ‘content’ (base64 encoded).
object
Optional additional file. Provide as FileType with ‘name’ and ‘content’ (base64 encoded).
object
Optional additional file. Provide as FileType with ‘name’ and ‘content’ (base64 encoded).
integer
The story ID that these files will be associated with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not