Shortcut

Learn how to use Shortcut with Composio

Overview

SLUG

SHORTCUT

Description

Shortcut aligns product development work with company objectives so teams can execute with a shared purpose.

Authentication Details

full
stringDefaults to https://api.app.shortcut.comRequired
generic_api_key
stringRequired

Tools

SLUG: SHORTCUT_GET_PROJECT

Get project returns information about the selected project.

Action Parameters

project__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_CATEGORIES

List categories returns a list of all categories and their attributes.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_EPICS

List epics returns a list of all epics and their attributes.

Action Parameters

includes_description
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_MILESTONES

(deprecated: use 'list objectives') list milestones returns a list of all milestones and their attributes.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_OBJECTIVES

List objectives returns a list of all objectives and their attributes.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_SEARCH_OBJECTIVES

Search objectives lets you search objectives based on desired parameters. since ordering of results can change over time (due to search ranking decay, new objectives being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Action Parameters

detail
string
entity_types
array
next
string
page_size
integer
query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_CATEGORY

Create category allows you to create a new category in shortcut.

Action Parameters

color
string
external_id
string
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_ENTITY_TEMPLATE

Create a new entity template for the workspace.

Action Parameters

author_id
string
name
stringRequired
story__contents__custom__fields
array
story__contents__deadline
string
story__contents__description
string
story__contents__epic__id
integer
story__contents__estimate
integer
story__contents__external__links
array
story__contents__file__ids
array
story__contents__follower__ids
array
story__contents__group__id
string
story__contents__iteration__id
integer
story__contents__labels
array
story__contents__linked__file__ids
array
story__contents__name
string
story__contents__owner__ids
array
story__contents__project__id
integer
story__contents__story__type
string
story__contents__tasks
array
story__contents__workflow__state__id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_EPIC

Create epic allows you to create a new epic in shortcut.

Action Parameters

completed_at_override
string
created_at
string
deadline
string
description
string
epic_state_id
integer
external_id
string
follower_ids
array
group_id
string
group_ids
array
labels
array
milestone_id
integer
name
stringRequired
objective_ids
array
owner_ids
array
planned_start_date
string
requested_by_id
string
started_at_override
string
state
string
updated_at
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_EPIC_COMMENT

This endpoint allows you to create a threaded comment on an epic.

Action Parameters

author_id
string
created_at
string
epic__public__id
integerRequired
external_id
string
text
stringRequired
updated_at
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_EPIC_COMMENT_COMMENT

This endpoint allows you to create a nested comment reply to an existing epic comment.

Action Parameters

author_id
string
comment__public__id
integerRequired
created_at
string
epic__public__id
integerRequired
external_id
string
text
stringRequired
updated_at
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_GROUP

Creates 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.

Action Parameters

color
string
color_key
string
description
string
display_icon_id
string
member_ids
array
mention_name
stringRequired
name
stringRequired
workflow_ids
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_ITERATION

The 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.

Action Parameters

description
string
end_date
stringRequired
follower_ids
array
group_ids
array
labels
array
name
stringRequired
start_date
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_LABEL

Create label allows you to create a new label in shortcut.

Action Parameters

color
string
description
string
external_id
string
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_LINKED_FILE

Create linked file allows you to create a new linked file in shortcut.

Action Parameters

content_type
string
description
string
name
stringRequired
size
integer
story_id
integer
thumbnail_url
string
type
stringRequired
uploader_id
string
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_MILESTONE

(deprecated: use 'create objective') create milestone allows you to create a new milestone in shortcut.

Action Parameters

categories
array
completed_at_override
string
description
string
name
stringRequired
started_at_override
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_MULTIPLE_STORIES

Create multiple stories allows you to create multiple stories in a single request using the same syntax as [create story](https://developer.shortcut.com/api/rest/v3#create-story).

Action Parameters

stories
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_OBJECTIVE

Create objective allows you to create a new objective in shortcut.

Action Parameters

categories
array
completed_at_override
string
description
string
name
stringRequired
started_at_override
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_PROJECT

Create project is used to create a new shortcut project.

Action Parameters

abbreviation
string
color
string
created_at
string
description
string
external_id
string
follower_ids
array
iteration_length
integer
name
stringRequired
start_time
string
team_id
integerRequired
updated_at
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_STORY

Create story is used to add a new story to your shortcut workspace. this endpoint requires that either **workflow state id** or **project id** be provided, but will reject the request if both or neither are specified. the workflow state id has been marked as required and is the recommended field to specify because we are in the process of sunsetting projects in shortcut.

Action Parameters

archived
boolean
comments
array
completed_at_override
string
created_at
string
custom_fields
array
deadline
string
description
string
epic_id
integer
estimate
integer
external_id
string
external_links
array
file_ids
array
follower_ids
array
group_id
string
iteration_id
integer
labels
array
linked_file_ids
array
move_to
string
name
stringRequired
owner_ids
array
project_id
integer
requested_by_id
string
source_task_id
integer
started_at_override
string
story_links
array
story_template_id
string
story_type
string
sub_tasks
array
tasks
array
updated_at
string
workflow_state_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_STORY_COMMENT

Create comment allows you to create a comment on any story.

Action Parameters

author_id
string
created_at
string
external_id
string
parent_id
integer
story__public__id
integerRequired
text
stringRequired
updated_at
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_STORY_FROM_TEMPLATE

Create story from template is used to add a new story derived from a template to your shortcut workspace.

Action Parameters

archived
boolean
comments
array
completed_at_override
string
created_at
string
custom_fields
array
custom_fields_add
array
custom_fields_remove
array
deadline
string
description
string
epic_id
integer
estimate
integer
external_id
string
external_links
array
external_links_add
array
external_links_remove
array
file_ids
array
file_ids_add
array
file_ids_remove
array
follower_ids
array
follower_ids_add
array
follower_ids_remove
array
group_id
string
iteration_id
integer
labels
array
labels_add
array
labels_remove
array
linked_file_ids
array
linked_file_ids_add
array
linked_file_ids_remove
array
move_to
string
name
string
owner_ids
array
owner_ids_add
array
owner_ids_remove
array
project_id
integer
requested_by_id
string
source_task_id
integer
started_at_override
string
story_links
array
story_template_id
stringRequired
story_type
string
sub_tasks
array
tasks
array
updated_at
string
workflow_state_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_STORY_LINK

Story links (called story relationships in the ui) allow you create semantic relationships between two stories. the parameters read like an active voice grammatical sentence: subject -> verb -> object. the subject story acts on the object story; the object story is the direct object of the sentence. the subject story "blocks", "duplicates", or "relates to" the object story. examples: - "story 5 blocks story 6” -- story 6 is now "blocked" until story 5 is moved to a done workflow state. - "story 2 duplicates story 1” -- story 2 represents the same body of work as story 1 (and should probably be archived). - "story 7 relates to story 3”

Action Parameters

object_id
integerRequired
subject_id
integerRequired
verb
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_STORY_REACTION

Create a reaction to a story comment.

Action Parameters

comment__public__id
integerRequired
emoji
stringRequired
story__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_CREATE_TASK

Create task is used to create a new task in a story.

Action Parameters

complete
boolean
created_at
string
description
stringRequired
external_id
string
owner_ids
array
story__public__id
integerRequired
updated_at
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_CATEGORY

Delete category can be used to delete any category.

Action Parameters

category__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_CUSTOM_FIELD

Deletes 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.

Action Parameters

custom__field__public__id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_ENTITY_TEMPLATE

Deletes 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.

Action Parameters

entity__template__public__id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_EPIC

Delete epic can be used to delete the epic. the only required parameter is epic id.

Action Parameters

epic__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_EPIC_COMMENT

This endpoint allows you to delete a comment from an epic.

Action Parameters

comment__public__id
integerRequired
epic__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_FILE

Delete file deletes a previously uploaded file.

Action Parameters

file__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_ITERATION

Deletes 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.

Action Parameters

iteration__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_LABEL

Delete label can be used to delete any label.

Action Parameters

label__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_LINKED_FILE

Delete linked file can be used to delete any previously attached linked-file.

Action Parameters

linked__file__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_MILESTONE

(deprecated: use 'delete objective') delete milestone can be used to delete any milestone.

Action Parameters

milestone__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_MULTIPLE_STORIES

Delete multiple stories allows you to delete multiple archived stories at once.

Action Parameters

story_ids
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_OBJECTIVE

Delete objective can be used to delete any objective.

Action Parameters

objective__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_PROJECT

Delete project can be used to delete a project. projects can only be deleted if all associated stories are moved or deleted. in the case that the project cannot be deleted, you will receive a 422 response.

Action Parameters

project__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_STORY

Delete story can be used to delete any story.

Action Parameters

story__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_STORY_COMMENT

Delete a comment from any story.

Action Parameters

comment__public__id
integerRequired
story__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_STORY_LINK

Removes the relationship between the stories for the given story link.

Action Parameters

story__link__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_STORY_REACTION

Delete a reaction from any story comment.

Action Parameters

comment__public__id
integerRequired
emoji
stringRequired
story__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DELETE_TASK

Delete task can be used to delete any previously created task on a story.

Action Parameters

story__public__id
integerRequired
task__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DISABLE_ITERATIONS

Disables iterations for the current workspace

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_DISABLE_STORY_TEMPLATES

Disables the story template feature for the workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_ENABLE_ITERATIONS

Enables iterations for the current workspace

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_ENABLE_STORY_TEMPLATES

Enables the story template feature for the workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_CATEGORY

Get category returns information about the selected category.

Action Parameters

category__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_CURRENT_MEMBER_INFO

Returns information about the authenticated member.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_CUSTOM_FIELD

Retrieves 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.

Action Parameters

custom__field__public__id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_ENTITY_TEMPLATE

Get entity template returns information about a given entity template.

Action Parameters

entity__template__public__id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_EPIC

Get epic returns information about the selected epic.

Action Parameters

epic__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_EPIC_COMMENT

This endpoint returns information about the selected epic comment.

Action Parameters

comment__public__id
integerRequired
epic__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_EPIC_WORKFLOW

Returns the epic workflow for the workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_FILE

Get file returns information about the selected uploadedfile.

Action Parameters

file__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_GROUP

Retrieves 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.

Action Parameters

group__public__id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_ITERATION

Retrieves detailed information about a specific iteration in the shortcut project management system. this endpoint allows users to fetch comprehensive data about a single iteration, including its name, status, start and end dates, associated stories, and progress metrics. it should be used when detailed information about a particular iteration is needed, such as during sprint planning, progress tracking, or retrospective analysis. the endpoint provides a snapshot of the iteration at the time of the request and does not include real-time updates. it's particularly useful for project managers, scrum masters, and team members who need to review or report on iteration-specific data. note that this endpoint only retrieves information and does not allow for modification of the iteration details.

Action Parameters

iteration__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_KEY_RESULT

Get key result returns information about a chosen key result.

Action Parameters

key__result__public__id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_LABEL

Get label returns information about the selected label.

Action Parameters

label__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_LINKED_FILE

Get file returns information about the selected linked file.

Action Parameters

linked__file__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_MEMBER

Returns information about a member.

Action Parameters

member__public__id
stringRequired
org__public__id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_MILESTONE

(deprecated: use 'get objective') get milestone returns information about a chosen milestone.

Action Parameters

milestone__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_OBJECTIVE

Get objective returns information about a chosen objective.

Action Parameters

objective__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_REPOSITORY

Get repository returns information about the selected repository.

Action Parameters

repo__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_STORY

Get story returns information about a chosen story.

Action Parameters

story__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_STORY_COMMENT

Get comment is used to get comment information.

Action Parameters

comment__public__id
integerRequired
story__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_STORY_LINK

Returns the stories and their relationship for the given story link.

Action Parameters

story__link__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_TASK

Returns information about a chosen task.

Action Parameters

story__public__id
integerRequired
task__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_GET_WORKFLOW

Get workflow returns information about a chosen workflow.

Action Parameters

workflow__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_CATEGORY_MILESTONES

List category milestones returns a list of all milestones with the category.

Action Parameters

category__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_CATEGORY_OBJECTIVES

Returns a list of all objectives with the category.

Action Parameters

category__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_CUSTOM_FIELDS

Retrieves 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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_ENTITY_TEMPLATES

List all the entity templates for the workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_EPIC_COMMENTS

Get a list of all comments on an epic.

Action Parameters

epic__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_EPIC_STORIES

Get a list of all stories in an epic.

Action Parameters

epic__public__id
integerRequired
includes_description
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_FILES

List files returns a list of all uploadedfiles in the workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_GROUPS

A group in our api maps to a "team" within the shortcut product. a team is a collection of users that can be associated to stories, epics, and iterations within shortcut.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_GROUP_STORIES

List the stories assigned to the group. (by default, limited to 1,000).

Action Parameters

group__public__id
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_ITERATIONS

Retrieves 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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_ITERATION_STORIES

Get a list of all stories in an iteration.

Action Parameters

includes_description
boolean
iteration__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_LABELS

List labels returns a list of all labels and their attributes.

Action Parameters

slim
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_LABEL_EPICS

List all of the epics with the label.

Action Parameters

label__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_LABEL_STORIES

List all of the stories with the label.

Action Parameters

includes_description
boolean
label__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_LINKED_FILES

List linked files returns a list of all linked-files and their attributes.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_MEMBERS

Returns information about members of the workspace.

Action Parameters

org__public__id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_MILESTONE_EPICS

(deprecated: use 'list objective epics') list all of the epics within the milestone.

Action Parameters

milestone__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_OBJECTIVE_EPICS

List all of the epics within the objective.

Action Parameters

objective__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_PROJECTS

List projects returns a list of all projects and their attributes.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_REPOSITORIES

List repositories returns a list of all repositories and their attributes.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_STORIES

List stories returns a list of all stories in a selected project and their attributes.

Action Parameters

includes_description
boolean
project__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_STORY_COMMENT

Lists comments associated with a story

Action Parameters

story__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_LIST_WORKFLOWS

Returns a list of all workflows in the workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_SEARCH_EPICS

Search epics lets you search epics based on desired parameters. since ordering of stories can change over time (due to search ranking decay, new epics being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Action Parameters

detail
string
entity_types
array
next
string
page_size
integer
query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_SEARCH_ITERATIONS

Search iterations lets you search iterations based on desired parameters. since ordering of results can change over time (due to search ranking decay, new iterations being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Action Parameters

detail
string
entity_types
array
next
string
page_size
integer
query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_SEARCH_MILESTONES

Search milestones lets you search milestones based on desired parameters. since ordering of results can change over time (due to search ranking decay, new milestones being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Action Parameters

detail
string
entity_types
array
next
string
page_size
integer
query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_SEARCH_STORIES

Search stories lets you search stories based on desired parameters. since ordering of stories can change over time (due to search ranking decay, new stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Action Parameters

detail
string
entity_types
array
next
string
page_size
integer
query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_SEARCH_STORIES_OLD

Search stories lets you search stories based on desired parameters.

Action Parameters

archived
boolean
completed_at_end
string
completed_at_start
string
created_at_end
string
created_at_start
string
deadline_end
string
deadline_start
string
epic_id
integer
epic_ids
array
estimate
integer
external_id
string
group_id
string
group_ids
array
includes_description
boolean
iteration_id
integer
iteration_ids
array
label_ids
array
label_name
string
owner_id
string
owner_ids
array
project_id
integer
project_ids
array
requested_by_id
string
story_type
string
updated_at_end
string
updated_at_start
string
workflow_state_id
integer
workflow_state_types
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_STORY_HISTORY

Retrieves 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.

Action Parameters

story__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_CATEGORY

Update category allows you to replace a category name with another name. if you try to name a category something that already exists, you will receive a 422 response.

Action Parameters

archived
boolean
category__public__id
integerRequired
color
string
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_CUSTOM_FIELD

Update custom field can be used to update the definition of a custom field. the order of items in the 'values' collection is interpreted to be their ascending sort order.to delete an existing enum value, simply omit it from the 'values' collection. new enum values may be created inline by including an object in the 'values' collection having a 'value' entry with no 'id' (eg. {'value': 'mynewvalue', 'color key': 'green'}).

Action Parameters

after_id
string
before_id
string
custom__field__public__id
stringRequired
description
string
enabled
boolean
icon_set_identifier
string
name
string
values
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_ENTITY_TEMPLATE

Update an entity template's name or its contents.

Action Parameters

entity__template__public__id
stringRequired
name
string
story__contents__custom__fields
array
story__contents__deadline
string
story__contents__description
string
story__contents__epic__id
integer
story__contents__estimate
integer
story__contents__external__links
array
story__contents__file__ids
array
story__contents__follower__ids
array
story__contents__group__id
string
story__contents__iteration__id
integer
story__contents__labels
array
story__contents__linked__file__ids
array
story__contents__name
string
story__contents__owner__ids
array
story__contents__project__id
integer
story__contents__story__type
string
story__contents__tasks
array
story__contents__workflow__state__id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_EPIC

Update epic can be used to update numerous fields in the epic. the only required parameter is epic id, which can be found in the shortcut ui.

Action Parameters

after_id
integer
archived
boolean
before_id
integer
completed_at_override
string
deadline
string
description
string
epic__public__id
integerRequired
epic_state_id
integer
external_id
string
follower_ids
array
group_id
string
group_ids
array
labels
array
milestone_id
integer
name
string
objective_ids
array
owner_ids
array
planned_start_date
string
requested_by_id
string
started_at_override
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_EPIC_COMMENT

This endpoint allows you to update a threaded comment on an epic.

Action Parameters

comment__public__id
integerRequired
epic__public__id
integerRequired
text
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_FILE

Update file updates the properties of an uploadedfile (but not its content).

Action Parameters

created_at
string
description
string
external_id
string
file__public__id
integerRequired
name
string
updated_at
string
uploader_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_GROUP

Updates 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.

Action Parameters

archived
boolean
color
string
color_key
string
description
string
display_icon_id
string
group__public__id
stringRequired
member_ids
array
mention_name
string
name
string
workflow_ids
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_ITERATION

This 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.

Action Parameters

description
string
end_date
string
follower_ids
array
group_ids
array
iteration__public__id
integerRequired
labels
array
name
string
start_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_KEY_RESULT

Update key result allows updating a key result's name or initial, observed, or target values.

Action Parameters

initial__observed__value__boolean__value
boolean
initial__observed__value__numeric__value
string
key__result__public__id
stringRequired
name
string
observed__value__boolean__value
boolean
observed__value__numeric__value
string
target__value__boolean__value
boolean
target__value__numeric__value
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_LABEL

Update label allows you to replace a label name with another name. if you try to name a label something that already exists, you will receive a 422 response.

Action Parameters

archived
boolean
color
string
description
string
label__public__id
integerRequired
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_LINKED_FILE

Updated linked file allows you to update properties of a previously attached linked-file.

Action Parameters

description
string
linked__file__public__id
integerRequired
name
string
size
integer
story_id
integer
thumbnail_url
string
type
string
uploader_id
string
url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_MILESTONE

(deprecated: use 'update objective') update milestone can be used to update milestone properties.

Action Parameters

after_id
integer
archived
boolean
before_id
integer
categories
array
completed_at_override
string
description
string
milestone__public__id
integerRequired
name
string
started_at_override
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_MULTIPLE_STORIES

Update multiple stories allows you to make changes to numerous stories at once.

Action Parameters

after_id
integer
archived
boolean
before_id
integer
custom_fields_add
array
custom_fields_remove
array
deadline
string
epic_id
integer
estimate
integer
external_links
array
follower_ids_add
array
follower_ids_remove
array
group_id
string
iteration_id
integer
labels_add
array
labels_remove
array
move_to
string
owner_ids_add
array
owner_ids_remove
array
project_id
integer
requested_by_id
string
story_ids
arrayRequired
story_type
string
workflow_state_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_OBJECTIVE

Update objective can be used to update objective properties.

Action Parameters

after_id
integer
archived
boolean
before_id
integer
categories
array
completed_at_override
string
description
string
name
string
objective__public__id
integerRequired
started_at_override
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_PROJECT

Update project can be used to change properties of a project.

Action Parameters

abbreviation
string
archived
boolean
color
string
days_to_thermometer
integer
description
string
follower_ids
array
name
string
project__public__id
integerRequired
show_thermometer
boolean
team_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_STORY

Update story can be used to update story properties.

Action Parameters

after_id
integer
archived
boolean
before_id
integer
branch_ids
array
commit_ids
array
completed_at_override
string
custom_fields
array
deadline
string
description
string
epic_id
integer
estimate
integer
external_links
array
file_ids
array
follower_ids
array
group_id
string
iteration_id
integer
labels
array
linked_file_ids
array
move_to
string
name
string
owner_ids
array
project_id
integer
pull_request_ids
array
requested_by_id
string
started_at_override
string
story__public__id
integerRequired
story_type
string
workflow_state_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_STORY_COMMENT

Update comment replaces the text of the existing comment.

Action Parameters

comment__public__id
integerRequired
story__public__id
integerRequired
text
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_STORY_LINK

Updates the stories and/or the relationship for the given story link.

Action Parameters

object_id
integer
story__link__public__id
integerRequired
subject_id
integer
verb
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPDATE_TASK

Update task can be used to update task properties.

Action Parameters

after_id
integer
before_id
integer
complete
boolean
description
string
owner_ids
array
story__public__id
integerRequired
task__public__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHORTCUT_UPLOAD_FILES

Upload files uploads one or many files and optionally associates them with a story. use the multipart/form-data content-type to upload. each `file` key should contain a separate file. each uploadedfile's name comes from the content-disposition header "filename" directive for that field.

Action Parameters

file0
object
file1
object
file2
object
file3
object
story_id
object

Action Response

data
objectRequired
error
string
successful
booleanRequired