- Category: project management
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 142
- Triggers: 0
- Slug:
SHORTCUT - Version: 20261101_00
Tools
Create category
Create category
Create doc
Create doc
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
Output
Create entity template
Create entity template
Create epic
Create epic
SHORTCUT_CREATE_EPICCreate Epic allows you to create a new Epic in Shortcut.Input Parameters
Deprecated The Epic”s state (to do, in progress, or done); will be ignored when epic_state_id is set.Output
Create epic comment
Create epic comment
SHORTCUT_CREATE_EPIC_COMMENTThis endpoint allows you to create a threaded Comment on an Epic.Input Parameters
Output
Create epic comment comment
Create epic comment comment
SHORTCUT_CREATE_EPIC_COMMENT_COMMENTThis endpoint allows you to create a nested Comment reply to an existing Epic Comment.Input Parameters
Output
Create epic health
Create epic health
Create generic integration
Create generic integration
Create group
Create group
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
Output
Create iteration
Create iteration
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
Output
Create label
Create label
Create linked file
Create linked file
Create milestone
Create milestone
Create multiple stories
Create multiple stories
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
Output
Create objective
Create objective
Create project
Create project
Create story
Create story
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
Output
Create story comment
Create story comment
SHORTCUT_CREATE_STORY_COMMENTCreate Comment allows you to create a Comment on any Story.Input Parameters
Output
Create story from template
Create story from template
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
labels.file_ids.labels.owners.file_ids.follower_ids.owners.custom_fields.external_links.follower_ids.linked_files.custom_fields.external_links.linked_files.Output
Create story link
Create story link
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
Output
Create story reaction
Create story reaction
Create task
Create task
SHORTCUT_CREATE_TASKCreate Task is used to create a new task in a Story.Input Parameters
Output
Delete category
Delete category
Delete custom field
Delete custom field
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
Output
Delete doc
Delete doc
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
Output
Delete entity template
Delete entity template
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
Output
Delete epic
Delete epic
Delete epic comment
Delete epic comment
Delete file
Delete file
Delete generic integration
Delete generic integration
Delete iteration
Delete iteration
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
Output
Delete label
Delete label
Delete linked file
Delete linked file
Delete milestone
Delete milestone
Delete multiple stories
Delete multiple stories
Delete objective
Delete objective
Delete project
Delete project
Delete story
Delete story
Delete story comment
Delete story comment
Delete story link
Delete story link
Delete story reaction
Delete story reaction
Delete task
Delete task
Disable iterations
Disable iterations
Disable story templates
Disable story templates
Enable iterations
Enable iterations
Enable story templates
Enable story templates
Get category
Get category
Get current member info
Get current member info
Get custom field
Get custom field
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
Output
Get doc
Get doc
Get entity template
Get entity template
Get epic
Get epic
Get epic comment
Get epic comment
Get epic health
Get epic health
Get epic workflow
Get epic workflow
Get external link stories
Get external link stories
Get file
Get file
Get generic integration
Get generic integration
Get group
Get group
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
Output
Get iteration
Get iteration
Get key result
Get key result
Get label
Get label
Get linked file
Get linked file
Get milestone
Get milestone
Get objective
Get objective
Get project
Get project
Get repository
Get repository
Get story
Get story
Get story comment
Get story comment
Get story link
Get story link
Get workflow
Get workflow
Link document to epic
Link document to epic
List categories
List categories
List category milestones
List category milestones
List category objectives
List category objectives
List custom fields
List custom fields
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
List docs
List docs
List document epics
List document epics
List entity templates
List entity templates
List epic comments
List epic comments
List epic documents
List epic documents
List epic healths
List epic healths
List epics
List epics
List epics paginated
List epics paginated
List epic stories
List epic stories
List files
List files
List groups
List groups
List group stories
List group stories
List iterations
List iterations
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
List iteration stories
List iteration stories
List label epics
List label epics
List labels
List labels
List label stories
List label stories
List linked files
List linked files
List members
List members
List members (slim)
List members (slim)
List milestone epics
List milestone epics
List milestones
List milestones
List objective epics
List objective epics
List objectives
List objectives
List projects
List projects
List repositories
List repositories
List stories
List stories
List story comment
List story comment
List story sub-tasks
List story sub-tasks
List workflows
List workflows
Search
Search
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
Output
Search documents
Search documents
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
Output
Search epics
Search epics
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
Output
Search iterations
Search iterations
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
Output
Search milestones
Search milestones
SHORTCUT_SEARCH_MILESTONESSearch milestones using a query and optional search parameters. Supply the previous response’s next value to request another page.Input Parameters
Output
Search objectives
Search objectives
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
Output
Search stories
Search stories
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
Output
Search stories old
Search stories old
Story history
Story history
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
Output
Unlink comment thread from slack
Unlink comment thread from slack
Unlink document from epic
Unlink document from epic
Unlink productboard from epic
Unlink productboard from epic
Update category
Update category
Update custom field
Update custom field
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
Output
Update Doc
Update Doc
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
Output
Update entity template
Update entity template
Update epic
Update epic
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
Deprecated The Epic”s state (to do, in progress, or done); will be ignored when epic_state_id is set.Output
Update epic comment
Update epic comment
Update file
Update file
Update group
Update group
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
Output
Update health status
Update health status
Update iteration
Update iteration
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
Output
Update key result
Update key result
Update label
Update label
Update linked file
Update linked file
Update milestone
Update milestone
Update multiple stories
Update multiple stories
SHORTCUT_UPDATE_MULTIPLE_STORIESUpdate Multiple Stories allows you to make changes to numerous stories at once.Input Parameters
Output
Update objective
Update objective
Update project
Update project
Update story
Update story
SHORTCUT_UPDATE_STORYUpdate Story can be used to update Story properties.Input Parameters
Output
Update story comment
Update story comment
Update story link
Update story link
Update task
Update task
Upload files
Upload files
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.