The Shortcut application url for the Story.
True if the story has been archived or not.
A true/false boolean indicating if the Story is currently blocked.
A true/false boolean indicating if the Story is currently a blocker of another story.
An array of Git branches attached to the story.
An array of comments attached to the story.
An array of commits attached to the story.
A true/false boolean indicating if the Story has been completed.
Optional completed_The time/date the Story was completed.
date-time
Optional completed_A manual override for the time/date the Story was completed.
date-time
The time/date the Story was created.
date-time
Optional custom_An array of CustomField value assertions for the story.
Optional cycle_The cycle time (in seconds) of this story when complete.
int64
Optional deadlineThe due date of the story.
date-time
The description of the story.
A string description of this resource.
Optional epic_The ID of the epic the story belongs to.
int64
Optional estimateThe numeric point estimate of the story. Can also be null, which means unestimated.
int64
Optional external_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.
An array of external links (strings) associated with a Story
An array of files attached to the story.
An array of UUIDs for any Members listed as Followers.
Optional group_The ID of the group associated with the story.
uuid
An array of Group IDs that have been mentioned in the Story description.
The unique ID of the Story.
int64
Optional iteration_The ID of the iteration the story belongs to.
int64
An array of label ids attached to the story.
An array of labels attached to the story.
Optional lead_The lead time (in seconds) of this story when complete.
int64
An array of linked files attached to the story.
An array of Member IDs that have been mentioned in the Story description.
Deprecated: use member_mention_ids.
Optional moved_The time/date the Story was last changed workflow-state.
date-time
The name of the story.
An array of UUIDs of the owners of this story.
A number representing the position of the story in relation to every other story in the current project.
int64
The IDs of the iteration the story belongs to.
Optional project_The ID of the project the story belongs to.
int64
An array of Pull/Merge Requests attached to the story.
The ID of the Member that requested the story.
uuid
A true/false boolean indicating if the Story has been started.
Optional started_The time/date the Story was started.
date-time
Optional started_A manual override for the time/date the Story was started.
date-time
The stats object for Stories
An array of story links attached to the Story.
Optional story_The ID of the story template used to create this story, or null if not created using a template.
uuid
The type of story (feature, bug, chore).
Optional synced_The synced item for the story.
An array of tasks connected to the story.
Optional unresolved_The IDs of any unresolved blocker comments on the Story.
Optional updated_The time/date the Story was updated.
date-time
The ID of the workflow the story belongs to.
int64
The ID of the workflow state the story is currently in.
int64
Generated using TypeDoc
Stories are the standard unit of work in Shortcut and represent individual features, bugs, and chores.