Stories
Returns a single story by ID.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the Story. | |
| GlobalId | String | True |
The global unique identifier of the Story in the format v2:s:workspace_id:story_id. | |
| Name | String | False |
The name of the Story (maximum length of 512 characters). | |
| Description | String | False |
The description of the Story, which supports Markdown formatting. | |
| StoryType | String | False |
The type of Story: feature, bug, or chore. | |
| AppUrl | String | True |
The URL to the Story in the Shortcut application. | |
| IsArchived | Boolean | False |
Indicates whether the Story is archived. | |
| IsCompleted | Boolean | True |
Indicates whether the Story has been completed. | |
| IsStarted | Boolean | True |
Indicates whether the Story has been started. | |
| IsBlocked | Boolean | True |
Indicates whether the Story is currently blocked. | |
| IsBlocker | Boolean | True |
Indicates whether the Story is blocking other Stories. | |
| Estimate | Integer | False |
The numeric point estimate for the Story. | |
| Position | Integer | True |
The numeric position of the Story within its workflow state. | |
| Deadline | Datetime | False |
The due date for the Story, if set. | |
| ProjectId | Integer | False |
Projects.Id |
Deprecated. The unique identifier of the Project the Story belongs to. |
| EpicId | Integer | False |
Epics.Id |
The unique identifier of the parent Epic, if assigned. |
| IterationId | Integer | False |
Iterations.Id |
The unique identifier of the Iteration (sprint) the Story is assigned to. |
| StoryTemplateId | String | False |
The unique identifier (UUID) of the Story template used to create this Story, if any. | |
| ParentStoryId | Integer | False |
Stories.Id |
The unique identifier of the parent Story if this is a sub-task Story. |
| SubTaskStoryIds | String | True |
An array of Story IDs that are sub-tasks of this Story. | |
| GroupId | String | False |
Groups.Id |
The unique identifier (UUID) of the associated Group (deprecated field). |
| WorkflowId | Integer | True |
Workflows.Id |
The unique identifier of the Workflow the Story follows. |
| WorkflowStateId | Integer | False |
The unique identifier of the current workflow state of the Story. | |
| RequestedById | String | False |
Members.Id |
The unique identifier (UUID) of the Member who requested the Story. |
| OwnerIds | String | False |
An array of Member UUIDs who are owners of the Story. | |
| FollowerIds | String | False |
An array of Member UUIDs who are following the Story. | |
| LabelIds | String | True |
An array of Label IDs associated with the Story. | |
| Labels | String | False |
An array of full Label objects associated with the Story. | |
| Tasks | String | False |
An array of Task objects that are part of this Story. | |
| Comments | String | False |
An array of Comment objects associated with the Story. | |
| Files | String | True |
An array of File objects uploaded to the Story. | |
| LinkedFiles | String | True |
An array of external file links associated with the Story. | |
| Branches | String | True |
An array of VCS branch objects linked to the Story. | |
| FormattedVcsBranchName | String | True |
The pre-formatted VCS branch name for this Story (e.g., feature/sc-17). | |
| Commits | String | True |
An array of VCS commit objects associated with the Story. | |
| PullRequests | String | True |
An array of pull request objects linked to the Story. | |
| StoryLinks | String | False |
An array of StoryLink objects representing relationships with other Stories. | |
| CustomFields | String | False |
An array of custom field values for the Story. | |
| ExternalId | String | False |
A reference identifier from an external system, if integrated. | |
| ExternalLinks | String | False |
An array of external link URLs associated with the Story. | |
| PreviousIterationIds | String | True |
An array of Iteration IDs that the Story was previously assigned to. | |
| MemberMentionIds | String | True |
An array of Member UUIDs who are mentioned in the Story. | |
| GroupMentionIds | String | True |
An array of Group UUIDs that are mentioned in the Story. | |
| MentionIds | String | True |
An array of all UUIDs (Members and Groups) mentioned in the Story. | |
| Stats | String | True |
A statistics object containing metadata about the Story. | |
| EntityType | String | True |
A string description of this resource, always set to 'story'. | |
| StartedAt | Datetime | True |
The timestamp when the Story was started. | |
| StartedAtOverride | Datetime | False |
A manually set override for the Story start timestamp. | |
| CompletedAt | Datetime | True |
The timestamp when the Story was completed. | |
| CompletedAtOverride | Datetime | False |
A manually set override for the Story completion timestamp. | |
| MovedAt | Datetime | True |
The timestamp when the Story was last moved to a different workflow state. | |
| CreatedAt | Datetime | False |
The timestamp when the Story was created. | |
| UpdatedAt | Datetime | False |
The timestamp when the Story was last updated. |