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.com
generic_api_key
stringRequired

Tools

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