Shortcut Software Stories API is one of 25 APIs that Shortcut Software publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Stories. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
23 operations
across 13 paths,
and defines 79 schemas.
It is described by OpenAPI 3.2.0, at version 3.0.
Requests are made against a single base URL, https://api.app.shortcut.com.
The identity and technical contract details declared by the specification.
Branch
object
Branch refers to a VCS branch. Branches are feature branches associated with Shortcut Stories.
11 properties
11 required
HistoryActionWorkspace2BulkUpdate
object
An action representing a bulk operation within a workspace2.
4 properties
4 required
HistoryActionStoryCommentCreate
object
An action representing a Story Comment being created.
5 properties
5 required
CreateStoryParams
object
Request parameters for creating a story.
32 properties
1 required
CreateStoryFromTemplateParams
object
Request parameters for creating a story from a story template. These parameters are merged with the values derived from the template.
46 properties
1 required
HistoryReferenceGeneral
object
A default reference for entity types that don't have extra fields.
3 properties
3 required
HistoryReferenceStory
object
A reference to a Story.
6 properties
5 required
StoryHistoryChangeOldNewUuid
object
The Team ID for the Story.
2 properties
PullRequest
object
Corresponds to a VCS Pull Request attached to a Shortcut story.
24 properties
20 required
CreateOrDeleteStoryReaction
object
1 property
1 required
Story
object
Stories are the standard unit of work in Shortcut and represent individual features, bugs, and chores.
56 properties
49 required
StoryReaction
object
Emoji reaction on a comment.
2 properties
2 required
HistoryActionStoryDelete
object
An action representing a Story being deleted.
6 properties
5 required
HistoryActionStoryLinkUpdate
object
An action representing a Story Link being updated.
7 properties
7 required
StoryHistoryChangeOldNewInt
object
The estimate value for the Story
2 properties
RemoveCustomFieldParams
object
1 property
1 required
LabelSlim
object
A Label can be used to associate and filter Stories and Epics, and also create new Workspaces. A slim Label does not include aggregate stats. Fetch the Label u…
11 properties
11 required
HistoryActionLabelUpdate
object
An action representing a Label being updated.
3 properties
3 required
UpdateStories
object
23 properties
1 required
StoryCustomField
object
3 properties
3 required
TypedStoryLink
object
The type of Story Link. The string can be subject or object.
9 properties
9 required
StoryHistoryChangeOldNewBool
object
True if the Story has archived, otherwise false.
2 properties
HistoryReferenceCustomFieldEnumValue
object
A reference to a CustomField value asserted on a Story.
8 properties
8 required
CreateLabelParams
object
Request parameters for creating a Label on a Shortcut Story.
4 properties
1 required
HistoryChangesStoryLink
object
The changes that have occurred as a result of the action.
3 properties
UpdateStory
object
29 properties
HistoryActionPullRequest
object
An action representing various operations for a Pull Request.
6 properties
6 required
Task
object
A Task on a Story.
15 properties
15 required
CustomFieldValueParams
object
3 properties
2 required
HistoryActionProjectUpdate
object
An action representing a Project being updated.
5 properties
5 required
CreateStoryLinkParams
object
Request parameters for creating a Story Link within a Story.
3 properties
1 required
UploadedFile
object
An UploadedFile is any document uploaded to your Shortcut Workspace. Files attached from a third-party service are different: see the Linked Files endpoint.
17 properties
17 required
HistoryActionStoryLinkDelete
object
An action representing a Story Link being deleted.
6 properties
6 required
DeleteStories
object
1 property
1 required
History
object
A history item is a group of actions that represent a transactional change to a Story.
11 properties
4 required
CreateStories
object
1 property
1 required
HistoryReferenceGroup
object
A reference to a Group.
3 properties
3 required
HistoryReferenceEpic
object
A reference to an Epic.
4 properties
4 required
HistoryActionStoryCreate
object
An action representing a Story being created.
27 properties
6 required
StoryComment
object
A Comment is any note added within the Comment field of a Story.
19 properties
16 required
StoryHistoryChangeAddsRemovesUuid
object
Custom Field Enum Value IDs that have been added or removed from the Story.
2 properties
HistoryActionLabelDelete
object
An action representing a Label being deleted.
4 properties
4 required
CreateStoryComment
object
6 properties
1 required
HistoryReferenceStoryTask
object
A reference to a Story Task.
3 properties
3 required
RemoveLabelParams
object
Request parameters for removing a Label from a Shortcut Story.
1 property
1 required
StoryStats
object
The stats object for Stories
1 property
1 required
CreateStoryCommentParams
object
Request parameters for creating a Comment on a Shortcut Story.
6 properties
1 required
HistoryReferenceProject
object
A reference to an Project.
4 properties
4 required
HistoryActionTaskCreate
object
An action representing a Task being created.
9 properties
5 required
CreateTaskParams
object
Request parameters for creating a Task on a Story.
6 properties
1 required
HistoryActionBranchPush
object
An action representing a VCS Branch being pushed.
5 properties
5 required
HistoryReferenceBranch
object
A reference to a VCS Branch.
4 properties
4 required
HistoryChangesStory
object
The changes that have occurred as a result of the action.
27 properties
LinkSubTaskParams
object
1 property
1 required
HistoryActionTaskUpdate
object
An action representing a Task being updated.
7 properties
6 required
HistoryActionStoryUpdate
object
An action representing a Story being updated.
8 properties
6 required
HistoryActionBranchCreate
object
An action representing a VCS Branch being created.
5 properties
5 required
LinkedFile
object
Linked files are stored on a third-party website and linked to one or more Stories. Shortcut currently supports linking files from Google Drive, Dropbox, Box,…
16 properties
16 required
StoryHistoryChangeOldNewStr
object
A timestamp that represents the Story's deadline.
2 properties
StoryHistoryChangeAddsRemovesInt
object
Task IDs that have been added or removed from the Story.
2 properties
UpdateStoryComment
object
1 property
1 required
HistoryActionStoryLinkCreate
object
An action representing a Story Link being created.
6 properties
6 required
CreateTask
object
6 properties
1 required
HistoryActionLabelCreate
object
An action representing a Label being created.
5 properties
5 required
StorySlim
object
StorySlim represents the same resource as a Story, but is more light-weight. For certain fields it provides ids rather than full resources (e.g., commentids an…
54 properties
46 required
HistoryReferenceWorkflowState
object
A references to a Story Workflow State.
4 properties
4 required
HistoryChangesTask
object
The changes that have occurred as a result of the action.
4 properties
Identity
object
The Identity of the VCS user that authored the Commit.
3 properties
3 required
HistoryReferenceIteration
object
A reference to an Iteration.
4 properties
4 required
Commit
object
Commit refers to a VCS commit and all associated details.
12 properties
12 required
PullRequestLabel
object
Corresponds to a VCS Label associated with a Pull Request.
5 properties
4 required
SearchStories
object
28 properties
HistoryActionBranchMerge
object
An action representing a VCS Branch being merged.
5 properties
5 required
UpdateTask
object
5 properties
HistoryActionTaskDelete
object
An action representing a Task being deleted.
4 properties
4 required
SyncedItem
object
The synced item for the story.
2 properties
2 required
CreateSubTaskParams
object
3 properties
1 required
HistoryReferenceCommit
object
A reference to a VCS Commit.
4 properties
4 required
HistoryReferenceLabel
object
A reference to an Label.
4 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Shortcut Software publishes across the network.
