shortcut
Module shortcut
API
Definitions
ballerinax/shortcut Ballerina library
Overview
Shortcut is a project management platform for software teams that organizes work into stories, epics, iterations and objectives. The Shortcut REST API (version 3) gives programmatic access to that work.
The Shortcut connector lets Ballerina applications read and manage stories, epics, iterations, labels, groups, milestones, objectives, documents, workflows and workspace members, and search across them.
Key features
- Create, update, search and delete stories, tasks, comments and story links
- Plan work with epics, iterations, milestones, objectives and categories
- Organize work with labels, groups, projects and custom fields
- Read workspace members, workflows and repositories
- Manage files, linked files, documents and entity templates
Setup guide
To use the Shortcut connector, you need a Shortcut workspace and an API token.
- Sign in to Shortcut.
- Open Settings and select API Tokens under your account.
- Enter a name for the token and click Generate Token.
- Copy the token and store it securely. It is shown only once.
Quickstart
To use the Shortcut connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
import ballerina/io; import ballerinax/shortcut;
Step 2: Instantiate a new connector
- Create a
Config.tomlfile and configure the token obtained in the steps above:
shortcutToken = "<Shortcut API token>"
- Create a
shortcut:ApiKeysConfigand initialize the connector with it.
configurable string shortcutToken = ?; final shortcut:Client shortcutClient = check new ({shortcutToken});
Step 3: Invoke the connector operation
List the epics in the workspace
public function main() returns error? { shortcut:EpicSlim[] epics = check shortcutClient->listEpics(); foreach shortcut:EpicSlim epic in epics { io:println(epic.id, ": ", epic.name); } }
Step 4: Run the Ballerina application
bal run
Examples
The Shortcut connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Iteration story planning - Create an iteration, add a story to it and set its estimate.
- Epic progress report - Report story progress for every epic and search stories.
Clients
shortcut: Client
Shortcut API
Constructor
Gets invoked to initialize the connector.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.app.shortcut.com/api/v3" - URL of the target service
listCategories
List Categories
createCategory
function createCategory(CreateCategory payload, map<string|string[]> headers) returns Category|errorCreate Category
Parameters
- payload CreateCategory - Payload for the Create Category operation
getCategory
Get Category
Parameters
- categoryPublicId int - The unique ID of the Category
updateCategory
function updateCategory(int categoryPublicId, UpdateCategory payload, map<string|string[]> headers) returns Category|errorUpdate Category
Parameters
- categoryPublicId int - The unique ID of the Category you wish to update
- payload UpdateCategory - Payload for the Update Category operation
deleteCategory
Delete Category
Parameters
- categoryPublicId int - The unique ID of the Category
Return Type
- error? - No Content
listCategoryMilestones
function listCategoryMilestones(int categoryPublicId, map<string|string[]> headers) returns Milestone[]|errorList Category Milestones
Parameters
- categoryPublicId int - The unique ID of the Category
listCategoryObjectives
function listCategoryObjectives(int categoryPublicId, map<string|string[]> headers) returns Milestone[]|errorList Category Objectives
Parameters
- categoryPublicId int - The unique ID of the Category
listCustomFields
function listCustomFields(map<string|string[]> headers) returns CustomField[]|errorList Custom Fields
Return Type
- CustomField[]|error - Resource
getCustomField
function getCustomField(string customFieldPublicId, map<string|string[]> headers) returns CustomField|errorGet Custom Field
Parameters
- customFieldPublicId string - The unique ID of the CustomField
Return Type
- CustomField|error - Resource
updateCustomField
function updateCustomField(string customFieldPublicId, UpdateCustomField payload, map<string|string[]> headers) returns CustomField|errorUpdate Custom Field
Parameters
- customFieldPublicId string - The unique ID of the CustomField
- payload UpdateCustomField - Payload for the Update Custom Field operation
Return Type
- CustomField|error - Resource
deleteCustomField
Delete Custom Field
Parameters
- customFieldPublicId string - The unique ID of the CustomField
Return Type
- error? - No Content
listDocs
List Docs
createDoc
Create Doc
Parameters
- payload CreateDoc - Payload for the Create Doc operation
getDoc
function getDoc(string docPublicId, map<string|string[]> headers, *GetDocQueries queries) returns Doc|errorGet Doc
Parameters
- docPublicId string - The Doc's public ID
- queries *GetDocQueries - Queries to be sent with the request
updateDoc
function updateDoc(string docPublicId, UpdateDoc payload, map<string|string[]> headers) returns Doc|errorUpdate Doc
Parameters
- docPublicId string - The Doc's public ID
- payload UpdateDoc - Payload for the Update Doc operation
deleteDoc
Delete Doc
Parameters
- docPublicId string - The Doc's public ID
- payload GetDoc - Payload for the Delete Doc operation
Return Type
- error? - No Content
listDocumentEpics
function listDocumentEpics(string docPublicId, map<string|string[]> headers) returns EpicSlim[]|errorList Document Epics
Parameters
- docPublicId string - The public ID of the Document
linkDocumentToEpic
function linkDocumentToEpic(string docPublicId, int epicPublicId, map<string|string[]> headers) returns error?Link Document to Epic
Parameters
- docPublicId string - The public ID of the Document
- epicPublicId int - The public ID of the Epic
Return Type
- error? - No Content
unlinkDocumentFromEpic
function unlinkDocumentFromEpic(string docPublicId, int epicPublicId, map<string|string[]> headers) returns error?Unlink Document from Epic
Parameters
- docPublicId string - The public ID of the Document
- epicPublicId int - The public ID of the Epic
Return Type
- error? - No Content
listEntityTemplates
function listEntityTemplates(map<string|string[]> headers) returns EntityTemplate[]|errorList Entity Templates
Return Type
- EntityTemplate[]|error - Resource
createEntityTemplate
function createEntityTemplate(CreateEntityTemplate payload, map<string|string[]> headers) returns EntityTemplate|errorCreate Entity Template
Parameters
- payload CreateEntityTemplate - Request parameters for creating an entirely new entity template
Return Type
- EntityTemplate|error - Resource
disableStoryTemplates
Disable Story Templates
Return Type
- error? - No Content
enableStoryTemplates
Enable Story Templates
Return Type
- error? - No Content
getEntityTemplate
function getEntityTemplate(string entityTemplatePublicId, map<string|string[]> headers) returns EntityTemplate|errorGet Entity Template
Parameters
- entityTemplatePublicId string - The unique ID of the entity template
Return Type
- EntityTemplate|error - Resource
updateEntityTemplate
function updateEntityTemplate(string entityTemplatePublicId, UpdateEntityTemplate payload, map<string|string[]> headers) returns EntityTemplate|errorUpdate Entity Template
Parameters
- entityTemplatePublicId string - The unique ID of the template to be updated
- payload UpdateEntityTemplate - Request parameters for changing either a template's name or any of
Return Type
- EntityTemplate|error - Resource
deleteEntityTemplate
function deleteEntityTemplate(string entityTemplatePublicId, map<string|string[]> headers) returns error?Delete Entity Template
Parameters
- entityTemplatePublicId string - The unique ID of the entity template
Return Type
- error? - No Content
getEpicWorkflow
function getEpicWorkflow(map<string|string[]> headers) returns EpicWorkflow|errorGet Epic Workflow
Return Type
- EpicWorkflow|error - Resource
listEpics
function listEpics(map<string|string[]> headers, *ListEpicsQueries queries) returns EpicSlim[]|errorList Epics
Parameters
- queries *ListEpicsQueries - Queries to be sent with the request
createEpic
Create Epic
Parameters
- payload CreateEpic - Payload for the Create Epic operation
listEpicsPaginated
function listEpicsPaginated(map<string|string[]> headers, *ListEpicsPaginatedQueries queries) returns EpicPaginatedResults|errorList Epics Paginated
Parameters
- queries *ListEpicsPaginatedQueries - Queries to be sent with the request
Return Type
- EpicPaginatedResults|error - Resource
getEpic
Get Epic
Parameters
- epicPublicId int - The unique ID of the Epic
updateEpic
function updateEpic(int epicPublicId, UpdateEpic payload, map<string|string[]> headers) returns Epic|errorUpdate Epic
Parameters
- epicPublicId int - The unique ID of the Epic
- payload UpdateEpic - Payload for the Update Epic operation
deleteEpic
Delete Epic
Parameters
- epicPublicId int - The unique ID of the Epic
Return Type
- error? - No Content
listEpicComments
function listEpicComments(int epicPublicId, map<string|string[]> headers) returns ThreadedComment[]|errorList Epic Comments
Parameters
- epicPublicId int - The unique ID of the Epic
Return Type
- ThreadedComment[]|error - Resource
createEpicComment
function createEpicComment(int epicPublicId, CreateEpicComment payload, map<string|string[]> headers) returns ThreadedComment|errorCreate Epic Comment
Parameters
- epicPublicId int - The ID of the associated Epic
- payload CreateEpicComment - Payload for the Create Epic Comment operation
Return Type
- ThreadedComment|error - Resource
getEpicComment
function getEpicComment(int epicPublicId, int commentPublicId, map<string|string[]> headers) returns ThreadedComment|errorGet Epic Comment
Parameters
- epicPublicId int - The ID of the associated Epic
- commentPublicId int - The ID of the Comment
Return Type
- ThreadedComment|error - Resource
updateEpicComment
function updateEpicComment(int epicPublicId, int commentPublicId, UpdateComment payload, map<string|string[]> headers) returns ThreadedComment|errorUpdate Epic Comment
Parameters
- epicPublicId int - The ID of the associated Epic
- commentPublicId int - The ID of the Comment
- payload UpdateComment - Payload for the Update Epic Comment operation
Return Type
- ThreadedComment|error - Resource
createEpicCommentComment
function createEpicCommentComment(int epicPublicId, int commentPublicId, CreateCommentComment payload, map<string|string[]> headers) returns ThreadedComment|errorCreate Epic Comment Comment
Parameters
- epicPublicId int - The ID of the associated Epic
- commentPublicId int - The ID of the parent Epic Comment
- payload CreateCommentComment - Payload for the Create Epic Comment Comment operation
Return Type
- ThreadedComment|error - Resource
deleteEpicComment
function deleteEpicComment(int epicPublicId, int commentPublicId, map<string|string[]> headers) returns error?Delete Epic Comment
Parameters
- epicPublicId int - The ID of the associated Epic
- commentPublicId int - The ID of the Comment
Return Type
- error? - No Content
listEpicDocuments
List Epic Documents
Parameters
- epicPublicId int - The unique ID of the Epic
getEpicHealth
Get Epic Health
Parameters
- epicPublicId int - The unique ID of the Epic
createEpicHealth
function createEpicHealth(int epicPublicId, CreateEpicHealth payload, map<string|string[]> headers) returns Health|errorCreate Epic Health
Parameters
- epicPublicId int - The unique ID of the Epic
- payload CreateEpicHealth - Payload for the Create Epic Health operation
listEpicHealths
List Epic Healths
Parameters
- epicPublicId int - The unique ID of the Epic
listEpicStories
function listEpicStories(int epicPublicId, map<string|string[]> headers, *ListEpicStoriesQueries queries) returns StorySlim[]|errorList Epic Stories
Parameters
- epicPublicId int - The unique ID of the Epic
- queries *ListEpicStoriesQueries - Queries to be sent with the request
getExternalLinkStories
function getExternalLinkStories(map<string|string[]> headers, *GetExternalLinkStoriesQueries queries) returns StorySlim[]|errorGet External Link Stories
Parameters
- queries *GetExternalLinkStoriesQueries - Queries to be sent with the request
listFiles
function listFiles(map<string|string[]> headers) returns UploadedFile[]|errorList Files
Return Type
- UploadedFile[]|error - Resource
uploadFiles
function uploadFiles(UploadFilesRequest payload, map<string|string[]> headers) returns UploadedFile[]|errorUpload Files
Parameters
- payload UploadFilesRequest - Payload for the Upload Files operation
Return Type
- UploadedFile[]|error - Resource
getFile
Get File
Parameters
- filePublicId int - The File’s unique ID
Return Type
- UploadedFile|error - Resource
updateFile
function updateFile(int filePublicId, UpdateFile payload, map<string|string[]> headers) returns UploadedFile|errorUpdate File
Parameters
- filePublicId int - The unique ID assigned to the file in Shortcut
- payload UpdateFile - Payload for the Update File operation
Return Type
- UploadedFile|error - Resource
deleteFile
Delete File
Parameters
- filePublicId int - The File’s unique ID
Return Type
- error? - No Content
listGroups
List Groups
Parameters
- queries *ListGroupsQueries - Queries to be sent with the request
createGroup
Create Group
Parameters
- payload CreateGroup - Payload for the Create Group operation
getGroup
Get Group
Parameters
- groupPublicId string - The unique ID of the Group
updateGroup
function updateGroup(string groupPublicId, UpdateGroup payload, map<string|string[]> headers) returns Group|errorUpdate Group
Parameters
- groupPublicId string - The unique ID of the Group
- payload UpdateGroup - Payload for the Update Group operation
listGroupStories
function listGroupStories(string groupPublicId, map<string|string[]> headers, *ListGroupStoriesQueries queries) returns StorySlim[]|errorList Group Stories
Parameters
- groupPublicId string - The unique ID of the Group
- queries *ListGroupStoriesQueries - Queries to be sent with the request
updateHealth
function updateHealth(string healthPublicId, UpdateHealth payload, map<string|string[]> headers) returns Health|errorUpdate Health
Parameters
- healthPublicId string - The unique ID of the Health record
- payload UpdateHealth - Payload for the Update Health operation
createGenericIntegration
function createGenericIntegration(CreateGenericIntegration payload, map<string|string[]> headers) returns error?Create Generic Integration
Parameters
- payload CreateGenericIntegration - Payload for the Create Generic Integration operation
Return Type
- error? - No Content
getGenericIntegration
function getGenericIntegration(int integrationPublicId, map<string|string[]> headers) returns error?Get Generic Integration
Parameters
- integrationPublicId int - The unique ID of the Generic Integration
Return Type
- error? - Resource
deleteGenericIntegration
function deleteGenericIntegration(int integrationPublicId, map<string|string[]> headers) returns error?Delete Generic Integration
Parameters
- integrationPublicId int - The unique ID of the Generic Integration
Return Type
- error? - No Content
listIterations
function listIterations(map<string|string[]> headers) returns IterationSlim[]|errorList Iterations
Return Type
- IterationSlim[]|error - Resource
createIteration
function createIteration(CreateIteration payload, map<string|string[]> headers) returns Iteration|errorCreate Iteration
Parameters
- payload CreateIteration - Payload for the Create Iteration operation
disableIterations
Disable Iterations
Return Type
- error? - No Content
enableIterations
Enable Iterations
Return Type
- error? - No Content
getIteration
Get Iteration
Parameters
- iterationPublicId int - The unique ID of the Iteration
updateIteration
function updateIteration(int iterationPublicId, UpdateIteration payload, map<string|string[]> headers) returns Iteration|errorUpdate Iteration
Parameters
- iterationPublicId int - The unique ID of the Iteration
- payload UpdateIteration - Payload for the Update Iteration operation
deleteIteration
Delete Iteration
Parameters
- iterationPublicId int - The unique ID of the Iteration
Return Type
- error? - No Content
listIterationStories
function listIterationStories(int iterationPublicId, map<string|string[]> headers, *ListIterationStoriesQueries queries) returns StorySlim[]|errorList Iteration Stories
Parameters
- iterationPublicId int - The unique ID of the Iteration
- queries *ListIterationStoriesQueries - Queries to be sent with the request
getKeyResult
function getKeyResult(string keyResultPublicId, map<string|string[]> headers) returns KeyResult|errorGet Key Result
Parameters
- keyResultPublicId string - The ID of the Key Result
updateKeyResult
function updateKeyResult(string keyResultPublicId, UpdateKeyResult payload, map<string|string[]> headers) returns KeyResult|errorUpdate Key Result
Parameters
- keyResultPublicId string - The ID of the Key Result
- payload UpdateKeyResult - Payload for the Update Key Result operation
listLabels
List Labels
Parameters
- queries *ListLabelsQueries - Queries to be sent with the request
createLabel
Create Label
Parameters
- payload CreateLabelParams - Request parameters for creating a Label on a Shortcut Story
getLabel
Get Label
Parameters
- labelPublicId int - The unique ID of the Label
updateLabel
function updateLabel(int labelPublicId, UpdateLabel payload, map<string|string[]> headers) returns Label|errorUpdate Label
Parameters
- labelPublicId int - The unique ID of the Label you wish to update
- payload UpdateLabel - Payload for the Update Label operation
deleteLabel
Delete Label
Parameters
- labelPublicId int - The unique ID of the Label
Return Type
- error? - No Content
listLabelEpics
List Label Epics
Parameters
- labelPublicId int - The unique ID of the Label
listLabelStories
function listLabelStories(int labelPublicId, map<string|string[]> headers, *ListLabelStoriesQueries queries) returns StorySlim[]|errorList Label Stories
Parameters
- labelPublicId int - The unique ID of the Label
- queries *ListLabelStoriesQueries - Queries to be sent with the request
listLinkedFiles
function listLinkedFiles(map<string|string[]> headers) returns LinkedFile[]|errorList Linked Files
Return Type
- LinkedFile[]|error - Resource
createLinkedFile
function createLinkedFile(CreateLinkedFile payload, map<string|string[]> headers) returns LinkedFile|errorCreate Linked File
Parameters
- payload CreateLinkedFile - Payload for the Create Linked File operation
Return Type
- LinkedFile|error - Resource
getLinkedFile
function getLinkedFile(int linkedFilePublicId, map<string|string[]> headers) returns LinkedFile|errorGet Linked File
Parameters
- linkedFilePublicId int - The unique identifier of the linked file
Return Type
- LinkedFile|error - Resource
updateLinkedFile
function updateLinkedFile(int linkedFilePublicId, UpdateLinkedFile payload, map<string|string[]> headers) returns LinkedFile|errorUpdate Linked File
Parameters
- linkedFilePublicId int - The unique identifier of the linked file
- payload UpdateLinkedFile - Payload for the Update Linked File operation
Return Type
- LinkedFile|error - Resource
deleteLinkedFile
Delete Linked File
Parameters
- linkedFilePublicId int - The unique identifier of the linked file
Return Type
- error? - No Content
getCurrentMemberInfo
function getCurrentMemberInfo(map<string|string[]> headers) returns MemberInfo|errorGet Current Member Info
Return Type
- MemberInfo|error - Resource
listMembers
function listMembers(map<string|string[]> headers, *ListMembersQueries queries) returns Member[]|errorList Members
Parameters
- queries *ListMembersQueries - Queries to be sent with the request
getMember
function getMember(string memberPublicId, map<string|string[]> headers, *GetMemberQueries queries) returns Member|errorGet Member
Parameters
- memberPublicId string - The Member's unique ID
- queries *GetMemberQueries - Queries to be sent with the request
listMilestones
List Milestones
Deprecated
createMilestone
function createMilestone(CreateMilestone payload, map<string|string[]> headers) returns Milestone|errorCreate Milestone
Parameters
- payload CreateMilestone - Payload for the Create Milestone operation
Deprecated
getMilestone
Get Milestone
Parameters
- milestonePublicId int - The ID of the Milestone
Deprecated
updateMilestone
function updateMilestone(int milestonePublicId, UpdateMilestone payload, map<string|string[]> headers) returns Milestone|errorUpdate Milestone
Parameters
- milestonePublicId int - The ID of the Milestone
- payload UpdateMilestone - Payload for the Update Milestone operation
Deprecated
deleteMilestone
Delete Milestone
Parameters
- milestonePublicId int - The ID of the Milestone
Return Type
- error? - No Content
Deprecated
listMilestoneEpics
function listMilestoneEpics(int milestonePublicId, map<string|string[]> headers) returns EpicSlim[]|errorList Milestone Epics
Parameters
- milestonePublicId int - The ID of the Milestone
Deprecated
listObjectives
List Objectives
createObjective
function createObjective(CreateObjective payload, map<string|string[]> headers) returns Objective|errorCreate Objective
Parameters
- payload CreateObjective - Payload for the Create Objective operation
getObjective
Get Objective
Parameters
- objectivePublicId int - The ID of the Objective
updateObjective
function updateObjective(int objectivePublicId, UpdateObjective payload, map<string|string[]> headers) returns Objective|errorUpdate Objective
Parameters
- objectivePublicId int - The ID of the Objective
- payload UpdateObjective - Payload for the Update Objective operation
deleteObjective
Delete Objective
Parameters
- objectivePublicId int - The ID of the Objective
Return Type
- error? - No Content
listObjectiveEpics
function listObjectiveEpics(int objectivePublicId, map<string|string[]> headers) returns EpicSlim[]|errorList Objective Epics
Parameters
- objectivePublicId int - The ID of the Objective
getObjectiveHealth
function getObjectiveHealth(int objectivePublicId, map<string|string[]> headers) returns Health|errorGet Objective Health
Parameters
- objectivePublicId int - The unique ID of the Objective
createObjectiveHealth
function createObjectiveHealth(int objectivePublicId, CreateObjectiveHealth payload, map<string|string[]> headers) returns Health|errorCreate Objective Health
Parameters
- objectivePublicId int - The unique ID of the Objective
- payload CreateObjectiveHealth - Payload for the Create Objective Health operation
listObjectiveHealths
function listObjectiveHealths(int objectivePublicId, map<string|string[]> headers) returns Health[]|errorList Objective Healths
Parameters
- objectivePublicId int - The unique ID of the Objective
listProjects
List Projects
createProject
Create Project
Parameters
- payload CreateProject - Payload for the Create Project operation
getProject
Get Project
Parameters
- projectPublicId int - The unique ID of the Project
updateProject
function updateProject(int projectPublicId, UpdateProject payload, map<string|string[]> headers) returns Project|errorUpdate Project
Parameters
- projectPublicId int - The unique ID of the Project
- payload UpdateProject - Payload for the Update Project operation
deleteProject
Delete Project
Parameters
- projectPublicId int - The unique ID of the Project
Return Type
- error? - No Content
listStories
function listStories(int projectPublicId, map<string|string[]> headers, *ListStoriesQueries queries) returns StorySlim[]|errorList Stories
Parameters
- projectPublicId int - The unique ID of the Project
- queries *ListStoriesQueries - Queries to be sent with the request
listRepositories
function listRepositories(map<string|string[]> headers) returns Repository[]|errorList Repositories
Return Type
- Repository[]|error - Resource
getRepository
Get Repository
Parameters
- repoPublicId int - The unique ID of the Repository
Return Type
- Repository|error - Resource
search
function search(map<string|string[]> headers, *SearchQueries queries) returns SearchResults|errorSearch
Parameters
- queries *SearchQueries - Queries to be sent with the request
Return Type
- SearchResults|error - Resource
searchDocuments
function searchDocuments(map<string|string[]> headers, *SearchDocumentsQueries queries) returns DocSearchResults|errorSearch Documents
Parameters
- queries *SearchDocumentsQueries - Queries to be sent with the request
Return Type
- DocSearchResults|error - Resource
searchEpics
function searchEpics(map<string|string[]> headers, *SearchEpicsQueries queries) returns EpicSearchResults|errorSearch Epics
Parameters
- queries *SearchEpicsQueries - Queries to be sent with the request
Return Type
- EpicSearchResults|error - Resource
searchIterations
function searchIterations(map<string|string[]> headers, *SearchIterationsQueries queries) returns IterationSearchResults|errorSearch Iterations
Parameters
- queries *SearchIterationsQueries - Queries to be sent with the request
Return Type
- IterationSearchResults|error - Resource
searchMilestones
function searchMilestones(map<string|string[]> headers, *SearchMilestonesQueries queries) returns ObjectiveSearchResults|errorSearch Milestones
Parameters
- queries *SearchMilestonesQueries - Queries to be sent with the request
Return Type
- ObjectiveSearchResults|error - Resource
searchObjectives
function searchObjectives(map<string|string[]> headers, *SearchObjectivesQueries queries) returns ObjectiveSearchResults|errorSearch Objectives
Parameters
- queries *SearchObjectivesQueries - Queries to be sent with the request
Return Type
- ObjectiveSearchResults|error - Resource
searchStories
function searchStories(map<string|string[]> headers, *SearchStoriesQueries queries) returns StorySearchResults|errorSearch Stories
Parameters
- queries *SearchStoriesQueries - Queries to be sent with the request
Return Type
- StorySearchResults|error - Resource
createStory
Create Story
Parameters
- payload CreateStoryParams - Request parameters for creating a story
updateMultipleStories
function updateMultipleStories(UpdateStories payload, map<string|string[]> headers) returns StorySlim[]|errorUpdate Multiple Stories
Parameters
- payload UpdateStories - Payload for the Update Multiple Stories operation
createMultipleStories
function createMultipleStories(CreateStories payload, map<string|string[]> headers) returns StorySlim[]|errorCreate Multiple Stories
Parameters
- payload CreateStories - Payload for the Create Multiple Stories operation
deleteMultipleStories
function deleteMultipleStories(DeleteStories payload, map<string|string[]> headers) returns error?Delete Multiple Stories
Parameters
- payload DeleteStories - Payload for the Delete Multiple Stories operation
Return Type
- error? - No Content
createStoryFromTemplate
function createStoryFromTemplate(CreateStoryFromTemplateParams payload, map<string|string[]> headers) returns Story|errorCreate Story From Template
Parameters
- payload CreateStoryFromTemplateParams - Request parameters for creating a story from a story template. These parameters are merged with the values derived from the template
queryStories
function queryStories(SearchStories payload, map<string|string[]> headers) returns StorySlim[]|errorQuery Stories
Parameters
- payload SearchStories - Payload for the Query Stories operation
getStory
Get Story
Parameters
- storyPublicId int - The ID of the Story
updateStory
function updateStory(int storyPublicId, UpdateStory payload, map<string|string[]> headers) returns Story|errorUpdate Story
Parameters
- storyPublicId int - The unique identifier of this story
- payload UpdateStory - Payload for the Update Story operation
deleteStory
Delete Story
Parameters
- storyPublicId int - The ID of the Story
Return Type
- error? - No Content
listStoryComment
function listStoryComment(int storyPublicId, map<string|string[]> headers) returns StoryComment[]|errorList Story Comment
Parameters
- storyPublicId int - The ID of the Story that the Comment is in
Return Type
- StoryComment[]|error - Resource
createStoryComment
function createStoryComment(int storyPublicId, CreateStoryComment payload, map<string|string[]> headers) returns StoryComment|errorCreate Story Comment
Parameters
- storyPublicId int - The ID of the Story that the Comment is in
- payload CreateStoryComment - Payload for the Create Story Comment operation
Return Type
- StoryComment|error - Resource
getStoryComment
function getStoryComment(int storyPublicId, int commentPublicId, map<string|string[]> headers) returns StoryComment|errorGet Story Comment
Parameters
- storyPublicId int - The ID of the Story that the Comment is in
- commentPublicId int - The ID of the Comment
Return Type
- StoryComment|error - Resource
updateStoryComment
function updateStoryComment(int storyPublicId, int commentPublicId, UpdateStoryComment payload, map<string|string[]> headers) returns StoryComment|errorUpdate Story Comment
Parameters
- storyPublicId int - The ID of the Story that the Comment is in
- commentPublicId int - The ID of the Comment
- payload UpdateStoryComment - Payload for the Update Story Comment operation
Return Type
- StoryComment|error - Resource
deleteStoryComment
function deleteStoryComment(int storyPublicId, int commentPublicId, map<string|string[]> headers) returns error?Delete Story Comment
Parameters
- storyPublicId int - The ID of the Story that the Comment is in
- commentPublicId int - The ID of the Comment
Return Type
- error? - No Content
createStoryReaction
function createStoryReaction(int storyPublicId, int commentPublicId, CreateOrDeleteStoryReaction payload, map<string|string[]> headers) returns StoryReaction[]|errorCreate Story Reaction
Parameters
- storyPublicId int - The ID of the Story that the Comment is in
- commentPublicId int - The ID of the Comment
- payload CreateOrDeleteStoryReaction - The emoji reaction to add to or remove from the story comment
Return Type
- StoryReaction[]|error - Resource
deleteStoryReaction
function deleteStoryReaction(int storyPublicId, int commentPublicId, CreateOrDeleteStoryReaction payload, map<string|string[]> headers) returns error?Delete Story Reaction
Parameters
- storyPublicId int - The ID of the Story that the Comment is in
- commentPublicId int - The ID of the Comment
- payload CreateOrDeleteStoryReaction - The emoji reaction to add to or remove from the story comment
Return Type
- error? - No Content
unlinkCommentThreadFromSlack
function unlinkCommentThreadFromSlack(int storyPublicId, int commentPublicId, map<string|string[]> headers) returns StoryComment|errorUnlink Comment thread from Slack
Parameters
- storyPublicId int - The ID of the Story to unlink
- commentPublicId int - The ID of the Comment to unlink
Return Type
- StoryComment|error - Resource
storyHistory
Story History
Parameters
- storyPublicId int - The ID of the Story
listStorySubTasks
function listStorySubTasks(int storyPublicId, map<string|string[]> headers) returns StorySlim[]|errorList Story Sub tasks
Parameters
- storyPublicId int - The ID of the Story
createTask
function createTask(int storyPublicId, CreateTask payload, map<string|string[]> headers) returns Task|errorCreate Task
Parameters
- storyPublicId int - The ID of the Story that the Task will be in
- payload CreateTask - Payload for the Create Task operation
getTask
function getTask(int storyPublicId, int taskPublicId, map<string|string[]> headers) returns Task|errorGet Task
Parameters
- storyPublicId int - The unique ID of the Story this Task is associated with
- taskPublicId int - The unique ID of the Task
updateTask
function updateTask(int storyPublicId, int taskPublicId, UpdateTask payload, map<string|string[]> headers) returns Task|errorUpdate Task
Parameters
- storyPublicId int - The unique identifier of the parent Story
- taskPublicId int - The unique identifier of the Task you wish to update
- payload UpdateTask - Payload for the Update Task operation
deleteTask
function deleteTask(int storyPublicId, int taskPublicId, map<string|string[]> headers) returns error?Delete Task
Parameters
- storyPublicId int - The unique ID of the Story this Task is associated with
- taskPublicId int - The unique ID of the Task
Return Type
- error? - No Content
createStoryLink
function createStoryLink(CreateStoryLink payload, map<string|string[]> headers) returns StoryLink|errorCreate Story Link
Parameters
- payload CreateStoryLink - Payload for the Create Story Link operation
getStoryLink
Get Story Link
Parameters
- storyLinkPublicId int - The unique ID of the Story Link
updateStoryLink
function updateStoryLink(int storyLinkPublicId, UpdateStoryLink payload, map<string|string[]> headers) returns StoryLink|errorUpdate Story Link
Parameters
- storyLinkPublicId int - The unique ID of the Story Link
- payload UpdateStoryLink - Payload for the Update Story Link operation
deleteStoryLink
Delete Story Link
Parameters
- storyLinkPublicId int - The unique ID of the Story Link
Return Type
- error? - No Content
listWorkflows
List Workflows
getWorkflow
Get Workflow
Parameters
- workflowPublicId int - The ID of the Workflow
Records
shortcut: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- shortcutToken string - Shortcut API token supplied in the Shortcut-Token request header
shortcut: BaseTaskParams
Request parameters for specifying how to pre-populate a task through a template
Fields
- description string - The Task description
- externalId? string - This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here
- complete? boolean - True/false boolean indicating whether the Task is completed. Defaults to false
- ownerIds? string[] - An array of UUIDs for any members you want to add as Owners on this new Task
shortcut: BasicWorkspaceInfo
Fields
- urlSlug string -
- utcOffset string -
- defaultWorkflowId int -
- koreyEnabled? boolean -
- name string -
- createdAt string -
- estimateScale int[] -
- id string -
shortcut: Branch
Branch refers to a VCS branch. Branches are feature branches associated with Shortcut Stories
Fields
- pullRequests PullRequest[] - An array of PullRequests attached to the Branch (there is usually only one)
- entityType string - A string description of this resource
- deleted boolean - A true/false boolean indicating if the Branch has been deleted
- updatedAt string? - The time/date the Branch was updated
- name string - The name of the Branch
- createdAt string? - The time/date the Branch was created
- repositoryId int - The ID of the Repository that contains the Branch
- id int? - The unique ID of the Branch
- persistent boolean - This field is deprecated, and will always be false
- mergedBranchIds int[] - The IDs of the Branches the Branch has been merged into
- url string - The URL of the Branch
shortcut: Category
A Category can be used to associate Objectives
Fields
- archived boolean - A true/false boolean indicating if the Category has been archived
- entityType string - A string description of this resource
- color string? - The hex color to be displayed with the Category (for example, "#ff0000")
- updatedAt string - The time/date that the Category was updated
- name string - The name of the Category
- globalId string - The Global ID of the Category
- createdAt string - The time/date that the Category was created
- externalId string? - This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here
- id int - The unique ID of the Category
- 'type string - The type of entity this Category is associated with; currently Milestone or Objective is the only type of Category
shortcut: Commit
Commit refers to a VCS commit and all associated details
Fields
- entityType string - A string description of this resource
- updatedAt string? - The time/date the Commit was updated
- authorIdentity Identity - The identity of the commit author
- authorEmail string - The email address of the VCS user that authored the Commit
- createdAt string - The time/date the Commit was created
- repositoryId int? - The ID of the Repository that contains the Commit
- id int? - The unique ID of the Commit
- authorId string? - The ID of the Member that authored the Commit, if known
- message string - The Commit message
- hash string - The Commit hash
- url string - The URL of the Commit
- timestamp string - The time/date the Commit was pushed
shortcut: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
shortcut: CreateCategory
Fields
- color? string - The hex color to be displayed with the Category (for example, "#ff0000")
- name string - The name of the new Category
- externalId? string - This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here
- 'type? anydata - The type of entity this Category is associated with; currently Milestone or Objective is the only type of Category
shortcut: CreateCategoryParams
Request parameters for creating a Category with a Objective
Fields
- color? string - The hex color to be displayed with the Category (for example, "#ff0000")
- name string - The name of the new Category
- externalId? string - This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here
shortcut: CreateCommentComment
Fields
- updatedAt? string - Defaults to the time/date the comment is last updated, but can be set to reflect another date
- createdAt? string - Defaults to the time/date the comment is created, but can be set to reflect another date
- externalId? string - This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here
- text string - The comment text
- authorId? string - The Member ID of the Comment's author. Defaults to the user identified by the API token
shortcut: CreateDoc
Fields
- contentFormat? "markdown"|"html" - Default content_format: html. Format of the content being sent. If 'markdown', content will be converted to HTML for storage. Storage is always HTML; this parameter just tells us what format you're sending
- title string - The title for the new document
- content string - The content for the new document
shortcut: CreateEntityTemplate
Request parameters for creating an entirely new entity template
Fields
- name string - The name of the new entity template
- authorId? string - The id of the user creating this template
- storyContents CreateStoryContents - The story contents the template creates
shortcut: CreateEpic
Fields
- requestedById? string - The ID of the member that requested the epic
- milestoneId? int? -
DeprecatedThe ID of the Milestone this Epic is related to. Useobjective_ids
- description? string - The Epic's description
- createdAt? string - Defaults to the time/date it is created but can be set to reflect another date
- externalId? string - This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here
- labels? CreateLabelParams[] - An array of Labels attached to the Epic
- objectiveIds? int[] - An array of IDs for Objectives to which this Epic is related
- startedAtOverride? string - A manual override for the time/date the Epic was started
- updatedAt? string - Defaults to the time/date it is created but can be set to reflect another date
- groupId? string? -
DeprecatedThe ID of the group to associate with the epic. Usegroup_ids
- epicStateId? int - The ID of the Epic State
- convertedFromStoryId? int? - The ID of the Story that was converted to an Epic
- followerIds? string[] - An array of UUIDs for any Members you want to add as Followers on this new Epic
- name string - The Epic's name
- plannedStartDate? string? - The Epic's planned start date
- groupIds? string[] - An array of UUIDS for Groups to which this Epic is related
- state? "in progress"|"to do"|"done" -
DeprecatedThe Epic's state (to do, in progress, or done); will be ignored whenepic_state_idis set
- deadline? string? - The Epic's deadline
- completedAtOverride? string - A manual override for the time/date the Epic was completed
- ownerIds? string[] - An array of UUIDs for any members you want to add as Owners on this new Epic
shortcut: CreateEpicComment
Fields
- updatedAt? string - Defaults to the time/date the comment is last updated, but can be set to reflect another date
- createdAt? string - Defaults to the time/date the comment is created, but can be set to reflect another date
- externalId? string - This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here
- text string - The comment text
- authorId? string - The Member ID of the Comment's author. Defaults to the user identified by the API token
shortcut: CreateEpicHealth
Fields
- text? string - The description of the Health status
- status "At Risk"|"On Track"|"Off Track"|"No Health" - The health status of the Epic
shortcut: CreateGenericIntegration
Fields
- webhookUrl string -
- secret? string -
shortcut: CreateGroup
Fields
- cardAgingMode? "off"|"gradual"|"immediate"? - The card aging mode for stories in this Group: "gradual" (fixed fade steps at 1, 2, and 4 weeks), "immediate", or "off" (explicitly disabled for this Group). Set to null to inherit the Workspace default
- workflowIds? int[] - The Workflow ids to add to the Group
- mentionName string - The mention name of this Group
- displayIconId? string - The Icon id for the avatar of this Group
- color? string - The color you wish to use for the Group in the system
- colorKey? "blue"|"purple"|"midnight-blue"|"orange"|"yellow-green"|"brass"|"gray"|"fuchsia"|"yellow"|"pink"|"sky-blue"|"green"|"red"|"black"|"slate"|"turquoise" - The color key you wish to use for the Group in the system
- memberIds? string[] - The Member ids to add to this Group
- name string - The name of this Group
- description? string - The description of the Group
- cardAgingThresholdDays? int? - The number of days an in-progress Story can go without activity before it is considered stale. Required when card_aging_mode is "immediate"; not allowed otherwise
shortcut: CreateIteration
Fields
- endDate string - The date this Iteration ends, e.g. 2019-07-01
- followerIds? string[] - An array of UUIDs for any Members you want to add as Followers
- groupIds? string[] - An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI
- name string - The name of this Iteration
- description? string - The description of the Iteration
- labels? CreateLabelParams[] - An array of Labels attached to the Iteration
- startDate string - The date this Iteration begins, e.g. 2019-07-01
shortcut: CreateLabelParams
Request parameters for creating a Label on a Shortcut Story
Fields
- color? string - The hex color to be displayed with the Label (for example, "#ff0000")
- name string - The name of the new Label
- description? string - The description of the new Label
- externalId? string - This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here
shortcut: CreateLinkedFile
Fields
- uploaderId? string - The UUID of the member that uploaded the file
- size? int - The filesize, if the integration provided it
- contentType? string - The content type of the image (e.g. txt/plain)
- storyId? int - The ID of the linked story
- name string - The name of the file
- description? string - The description of the file
- thumbnailUrl? string - The URL of the thumbnail, if the integration provided it
- 'type "google"|"url"|"dropbox"|"box"|"onedrive" - The integration type of the file (e.g. google, dropbox, box)
- url string - The URL of linked file
shortcut: CreateMilestone
Fields
- startedAtOverride? string - A manual override for the time/date the Milestone was started
- name string - The name of the Milestone
- description? string - The Milestone's description
- state? "in progress"|"to do"|"done" - The workflow state that the Milestone is in
- categories? CreateCategoryParams[] - An array of IDs of Categories attached to the Milestone
- completedAtOverride? string - A manual override for the time/date the Milestone was completed
shortcut: CreateObjective
Fields
- startedAtOverride? string - A manual override for the time/date the Objective was started
- name string - The name of the Objective
- description? string - The Objective's description
- state? "in progress"|"to do"|"done" - The workflow state that the Objective is in
- categories? CreateCategoryParams[] - An array of IDs of Categories attached to the Objective
- completedAtOverride? string - A manual override for the time/date the Objective was completed
shortcut: CreateObjectiveHealth
Fields
- text? string - The description of the Health status
- status "At Risk"|"On Track"|"Off Track"|"No Health" - The health status of the Objective
shortcut: CreateOrDeleteStoryReaction
Fields
- emoji string - The emoji short-code to add / remove. E.g.
:thumbsup::skin-tone-4:
shortcut: CreateProject
Fields
- startTime? string - The date at which the Project was started
- color? string - The color you wish to use for the Project in the system
- updatedAt? string - Defaults to the time/date it is created but can be set to reflect another date
- followerIds? string[] - An array of UUIDs for any members you want to add as Owners on this new Epic
- name string - The name of the Project
- description? string - The Project description
- createdAt? string - Defaults to the time/date it is created but can be set to reflect another date
- externalId? string - This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here
- teamId int - The ID of the team the project belongs to
- abbreviation? string - The Project abbreviation used in Story summaries. Should be kept to 3 characters at most
- iterationLength? int - The number of weeks per iteration in this Project
shortcut: CreateStories
Fields
- stories CreateStoryParams[] - An array of stories to be created
shortcut: CreateStoryComment
Fields
- updatedAt? string - Defaults to the time/date the comment is last updated, but can be set to reflect another date
- parentId? int? - The ID of the Comment that this comment is threaded under
- createdAt? string - Defaults to the time/date the comment is created, but can be set to reflect another date
- externalId? string - This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here
- text string - The comment text
- authorId? string - The Member ID of the Comment's author. Defaults to the user identified by the API token
shortcut: CreateStoryCommentParams
Request parameters for creating a Comment on a Shortcut Story
Fields
- updatedAt? string - Defaults to the time/date the comment is last updated, but can be set to reflect another date
- parentId? int? - The ID of the Comment that this comment is threaded under
- createdAt? string - Defaults to the time/date the comment is created, but can be set to reflect another date
- externalId? string - This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here
- text string - The comment text
- authorId? string - The Member ID of the Comment's author. Defaults to the user identified by the API token
shortcut: CreateStoryContents
A map of story attributes this template populates
Fields
- workflowStateId? int? - The ID of the workflow state to be populated
- customFields? CustomFieldValueParams[] - An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField
- description? string - The description of the story
- linkedFileIds? int[] - An array of the linked file IDs to be populated
- labels? CreateLabelParams[] - An array of labels to be populated by the template
- iterationId? int? - The ID of the iteration the to be populated
- storyType? string - The type of story (feature, bug, chore)
- groupId? string? - The ID of the group to be populated
- projectId? int - The ID of the project the story belongs to
- externalLinks? string[] - An array of external links to be populated
- followerIds? string[] - An array of UUIDs for any Members listed as Followers
- fileIds? int[] - An array of the attached file IDs to be populated
- name? string - The name of the story
- estimate? int? - The numeric point estimate to be populated
- subTasks? CreateSubTaskParams[] - An array of maps specifying the sub-tasks to create and link to the story. Field only applicable when Sub-task feature is enabled
- deadline? string? - The due date of the story
- tasks? BaseTaskParams[] - An array of tasks to be populated by the template
- ownerIds? string[] - An array of UUIDs of the owners of this story
- epicId? int? - The ID of the epic the to be populated
shortcut: CreateStoryFromTemplateParams
Request parameters for creating a story from a story template. These parameters are merged with the values derived from the template
Fields
- workflowStateId? int - The ID of the workflow state the story will be in
- requestedById? string - The ID of the member that requested the story
- ownerIdsRemove? string[] - The UUIDs of the new owners to be removed from owners from the template. Cannot be used in conjunction with
owners
- customFieldsAdd? CustomFieldValueParams[] - A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. These will be added to any fields provided by the template. Cannot be used in conjunction with
custom_fields
- description? string - The description of the story
- linkedFileIds? int[] - An array of IDs of linked files attached to the story
- createdAt? string - The time/date the Story was created
- externalId? string - 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
- linkedFileIdsAdd? int[] - An array of IDs of linked files attached to the story in addition to files from the template. Cannot be used in conjunction with
linked_files
- storyType? "feature"|"chore"|"bug" - The type of story (feature, bug, chore)
- archived? boolean - Controls the story's archived state
- parentStoryId? int? - The ID of the parent story to associate with this story (making the created story a sub-task). Field only applicable when Sub-task feature is enabled
- fileIdsRemove? int[] - An array of IDs of files removed from files from the template. Cannot be used in conjunction with
file_ids
- externalLinksAdd? string[] - An array of External Links associated with this story. These will be added to any links provided by the template. Cannot be used in conjunction with
external_links
- updatedAt? string - The time/date the Story was updated
- storyTemplateId string - The id of the story template used to create this story
- projectId? int? - The ID of the project the story belongs to
- followerIdsRemove? string[] - The UUIDs of the new followers to be removed from followers from the template. Cannot be used in conjunction with
follower_ids
- followerIds? string[] - An array of UUIDs of the followers of this story
- fileIds? int[] - An array of IDs of files attached to the story
- estimate? int? - The numeric point estimate of the story. Can also be null, which means unestimated
- labelsRemove? RemoveLabelParams[] - An array of labels to remove from the labels provided by the template. Cannot be used in conjunction with
labels
- externalLinksRemove? string[] - An array of External Links associated with this story. These will be removed from any links provided by the template. Cannot be used in conjunction with
external_links
- deadline? string? - The due date of the story
- tasks? CreateTaskParams[] - An array of tasks connected to the story
- labelsAdd? CreateLabelParams[] - An array of labels attached to the story in addition to the labels provided by the template. Cannot be used in conjunction with
labels
- fileIdsAdd? int[] - An array of IDs of files attached to the story in addition to files from the template. Cannot be used in conjunction with
file_ids
- comments? CreateStoryCommentParams[] - An array of comments to add to the story
- customFields? CustomFieldValueParams[] - A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField
- linkedFileIdsRemove? int[] - An array of IDs of linked files removed from files from the template. Cannot be used in conjunction with
linked_files.
- storyLinks? CreateStoryLinkParams[] - An array of story links attached to the story
- customFieldsRemove? RemoveCustomFieldParams[] - A map specifying a CustomField ID. These will be removed from any fields provided by the template. Cannot be used in conjunction with
custom_fields
- labels? CreateLabelParams[] - An array of labels attached to the story
- iterationId? int? - The ID of the iteration the story belongs to
- ownerIdsAdd? string[] - The UUIDs of the new owners to be added in addition to owners from the template. Cannot be used in conjunction with
owners
- startedAtOverride? string - A manual override for the time/date the Story was started
- groupId? string? - The id of the group to associate with this story
- moveTo? "last"|"first" - One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state
- externalLinks? string[] - An array of External Links associated with this story
- name? string - The name of the story. Must be provided if the template does not provide a name
- subTasks? CreateStoryFromTemplateParamsSubTasks[] - An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story. Field only applicable when Sub-task feature is enabled
- followerIdsAdd? string[] - The UUIDs of the new followers to be added in addition to followers from the template. Cannot be used in conjunction with
follower_ids.
- sourceTaskId? int? - Given this story was converted from a task in another story, this is the original task ID that was converted to this story
- completedAtOverride? string - A manual override for the time/date the Story was completed
- ownerIds? string[] - An array of UUIDs of the owners of this story
- epicId? int? - The ID of the epic the story belongs to
shortcut: CreateStoryLink
Fields
- subjectId int - The ID of the subject Story
- verb "blocks"|"duplicates"|"relates to" - The type of link
- objectId int - The ID of the object Story
shortcut: CreateStoryLinkParams
Request parameters for creating a Story Link within a Story
Fields
- subjectId? int - The unique ID of the Story defined as subject
- verb "blocks"|"duplicates"|"relates to" - How the subject Story acts on the object Story. This can be "blocks", "duplicates", or "relates to"
- objectId? int - The unique ID of the Story defined as object
shortcut: CreateStoryParams
Request parameters for creating a story
Fields
- workflowStateId? int - The ID of the workflow state the story will be in
- requestedById? string - The ID of the member that requested the story
- description? string - The description of the story
- linkedFileIds? int[] - An array of IDs of linked files attached to the story
- createdAt? string - The time/date the Story was created
- externalId? string - 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
- storyType? "feature"|"chore"|"bug" - The type of story (feature, bug, chore)
- archived? boolean - Controls the story's archived state
- parentStoryId? int? - The ID of the parent story to associate with this story (making the created story a sub-task). Field only applicable when Sub-task feature is enabled
- updatedAt? string - The time/date the Story was updated
- storyTemplateId? string? - The id of the story template used to create this story, if applicable. This is just an association; no content from the story template is inherited by the story simply by setting this field
- projectId? int? - The ID of the project the story belongs to
- followerIds? string[] - An array of UUIDs of the followers of this story
- fileIds? int[] - An array of IDs of files attached to the story
- estimate? int? - The numeric point estimate of the story. Can also be null, which means unestimated
- deadline? string? - The due date of the story
- tasks? CreateTaskParams[] - An array of tasks connected to the story
- comments? CreateStoryCommentParams[] - An array of comments to add to the story
- customFields? CustomFieldValueParams[] - A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField
- storyLinks? CreateStoryLinkParams[] - An array of story links attached to the story
- labels? CreateLabelParams[] - An array of labels attached to the story
- iterationId? int? - The ID of the iteration the story belongs to
- startedAtOverride? string - A manual override for the time/date the Story was started
- groupId? string? - The id of the group to associate with this story
- moveTo? "last"|"first" - One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state
- externalLinks? string[] - An array of External Links associated with this story
- name string - The name of the story
- subTasks? CreateStoryFromTemplateParamsSubTasks[] - An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story. Field only applicable when Sub-task feature is enabled
- sourceTaskId? int? - Given this story was converted from a task in another story, this is the original task ID that was converted to this story
- completedAtOverride? string - A manual override for the time/date the Story was completed
- ownerIds? string[] - An array of UUIDs of the owners of this story
- epicId? int? - The ID of the epic the story belongs to
shortcut: CreateSubTaskParams
Fields
- workflowStateId? int - The ID of the workflow state the story will be in
- name string - The name of the SubTask
- ownerIds? string[] - An array of UUIDs of the owners of this story
shortcut: CreateTask
Fields
- updatedAt? string - Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date
- description string - The Task description
- createdAt? string - Defaults to the time/date the Task is created but can be set to reflect another creation time/date
- externalId? string - This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here
- complete? boolean - True/false boolean indicating whether the Task is completed. Defaults to false
- ownerIds? string[] - An array of UUIDs for any members you want to add as Owners on this new Task
shortcut: CreateTaskParams
Request parameters for creating a Task on a Story
Fields
- updatedAt? string - Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date
- description string - The Task description
- createdAt? string - Defaults to the time/date the Task is created but can be set to reflect another creation time/date
- externalId? string - This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here
- complete? boolean - True/false boolean indicating whether the Task is completed. Defaults to false
- ownerIds? string[] - An array of UUIDs for any members you want to add as Owners on this new Task
shortcut: CustomField
Fields
- canonicalName? string - The canonical name for a Shortcut-defined field
- values? CustomFieldEnumValue[] - A collection of legal values for a CustomField
- description? string - A string description of the CustomField
- createdAt string - The instant when this CustomField was created
- iconSetIdentifier? string - A string that represents the icon that corresponds to this custom field
- enabled boolean - When true, the CustomField can be applied to entities in the Workspace
- storyTypes? string[] - The types of stories this CustomField is scoped to
- fixedPosition? boolean - When true, the CustomFieldEnumValues may not be reordered
- entityType "custom-field" - A string description of this resource
- updatedAt string - The instant when this CustomField was last updated
- name string - The name of the Custom Field
- id string - The unique public ID for the CustomField
- position int - An integer indicating the position of this Custom Field with respect to the other CustomField
- fieldType "enum" - The type of Custom Field, eg. 'enum'
shortcut: CustomFieldEnumValue
Fields
- entityType "custom-field-enum-value" - A string description of this resource
- colorKey string? - A color key associated with this CustomFieldEnumValue
- id string - The unique public ID for the Custom Field
- position int - An integer indicating the position of this Value with respect to the other CustomFieldEnumValues in the enumeration
- value string - A string value within the domain of this Custom Field
- enabled boolean - When true, the CustomFieldEnumValue can be selected for the CustomField
shortcut: CustomFieldValueParams
Fields
- fieldId string - The unique public ID for the CustomField
- valueId string - The unique public ID for the CustomFieldEnumValue
- value? string - A literal value for the CustomField. Currently ignored
shortcut: DeleteStories
Fields
- storyIds int[] - An array of IDs of Stories to delete
shortcut: Doc
Fields
- archived boolean - Whether the Doc is archived
- contentMarkdown string? - The Doc's content in Markdown format (converted from HTML storage)
- appUrl string - The Shortcut application url for the Doc
- updatedAt string - The time/date the Doc was last updated
- createdAt string - The time/date the Doc was created
- id string - The public id of the Doc
- title string? - The Doc's title
- contentHtml? string? - The Doc's content in HTML format (as stored in S3). Only included when include_html=true query parameter is provided
shortcut: DocSearchResults
The results of the Document search query
Fields
- next string? - The URL path and query string for the next page of search results
- total int - The total number of matches for the search query. The first 1000 matches can be paged through via the API
- data DocSlim[] - A list of document search results
shortcut: DocSlim
Fields
- appUrl string - The Shortcut application url for the Doc
- id string - The public id of the Doc
- title string? - The Docs Title
shortcut: EntityTemplate
An entity template can be used to prefill various fields when creating new stories
Fields
- lastUsedAt string - The last time that someone created an entity using this template
- entityType string - A string description of this resource
- updatedAt string - The time/date when the entity template was last updated
- name string - The template's name
- createdAt string - The time/date when the entity template was created
- id string - The unique identifier for the entity template
- authorId string - The unique ID of the member who created the template
- storyContents StoryContents - The story contents the template creates
shortcut: Epic
An Epic is a collection of stories that together might make up a release, a objective, or some other large initiative that you are working on
Fields
- requestedById string - The ID of the Member that requested the epic
- productboardName string? - The name of the associated productboard feature
- milestoneId int? -
DeprecatedThe ID of the Objective this Epic is related to. Useobjective_ids
- description string - The Epic's description
- productboardPluginId string? - The ID of the associated productboard integration
- createdAt string? - The time/date the Epic was created
- groupMentionIds string[] - An array of Group IDs that have been mentioned in the Epic description
- externalId string? - This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here
- archived boolean - True/false boolean that indicates whether the Epic is archived or not
- associatedGroups EpicAssociatedGroup[] - An array containing Group IDs and Group-owned story counts for the Epic's associated groups
- storiesWithoutProjects int - The number of stories in this epic which are not associated with a project
- updatedAt string? - The time/date the Epic was updated
- stats EpicStats - A group of calculated values for this Epic
- epicStateId int - The ID of the Epic State
- productboardUrl string? - The URL of the associated productboard feature
- followerIds string[] - An array of UUIDs for any Members you want to add as Followers on this Epic
- groupIds string[] - An array of UUIDS for Groups to which this Epic is related
- state string -
DeprecatedThe workflow state that the Epic is in
- id int - The unique ID of the Epic
- deadline string? - The Epic's deadline
- memberMentionIds string[] - An array of Member IDs that have been mentioned in the Epic description
- appUrl string - The Shortcut application url for the Epic
- comments ThreadedComment[] - A nested array of threaded comments
- productboardId string? - The ID of the associated productboard feature
- labelIds int[] - An array of Label ids attached to the Epic
- globalId string - The globally unique identifier of the resource
- health? Health - The current health status of the Epic
- started boolean - A true/false boolean indicating if the Epic has been started
- completed boolean - A true/false boolean indicating if the Epic has been completed
- projectIds int[] - The IDs of Projects related to this Epic
- labels LabelSlim[] - An array of Labels attached to the Epic
- objectiveIds int[] - An array of IDs for Objectives to which this epic is related
- completedAt string? - The time/date the Epic was completed
- entityType string - A string description of this resource
- startedAtOverride string? - A manual override for the time/date the Epic was started
- groupId string? -
DeprecatedThe ID of the group to associate with the epic. Usegroup_ids
- name string - The name of the Epic
- plannedStartDate string? - The Epic's planned start date
- startedAt string? - The time/date the Epic was started
- position int - The Epic's relative position in the Epic workflow state
- completedAtOverride string? - A manual override for the time/date the Epic was completed
- ownerIds string[] - An array of UUIDs for any members you want to add as Owners on this new Epic
- mentionIds string[] -
Deprecated:usemember_mention_ids
shortcut: EpicAssociatedGroup
Fields
- groupId string - The Group ID of the associated group
- associatedStoriesCount? int - The number of stories this Group owns in the Epic
shortcut: EpicPaginatedResults
Results schema for paginated Epic listing
Fields
- next int? - The next page number if there are more results, or null for the last page
- total int - The total number of Epics matching the query over all pages
- data EpicSlim[] - Array of Epic objects on the current page
shortcut: EpicSearchResult
An Epic in search results. This is typed differently from Epic because the details=slim search argument will omit some fields
Fields
- requestedById string - The ID of the Member that requested the epic
- productboardName string? - The name of the associated productboard feature
- milestoneId int? -
DeprecatedThe ID of the Objective this Epic is related to. Useobjective_ids
- description? string - The Epic's description
- productboardPluginId string? - The ID of the associated productboard integration
- createdAt string? - The time/date the Epic was created
- groupMentionIds string[] - An array of Group IDs that have been mentioned in the Epic description
- externalId string? - This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here
- archived boolean - True/false boolean that indicates whether the Epic is archived or not
- associatedGroups EpicAssociatedGroup[] - An array containing Group IDs and Group-owned story counts for the Epic's associated groups
- storiesWithoutProjects int - The number of stories in this epic which are not associated with a project
- updatedAt string? - The time/date the Epic was updated
- stats EpicStats - A group of calculated values for this Epic
- epicStateId int - The ID of the Epic State
- productboardUrl string? - The URL of the associated productboard feature
- followerIds string[] - An array of UUIDs for any Members you want to add as Followers on this Epic
- groupIds string[] - An array of UUIDS for Groups to which this Epic is related
- state string -
DeprecatedThe workflow state that the Epic is in
- id int - The unique ID of the Epic
- deadline string? - The Epic's deadline
- memberMentionIds string[] - An array of Member IDs that have been mentioned in the Epic description
- appUrl string - The Shortcut application url for the Epic
- comments? ThreadedComment[] - A nested array of threaded comments
- productboardId string? - The ID of the associated productboard feature
- labelIds int[] - An array of Label ids attached to the Epic
- globalId string - The globally unique identifier of the resource
- health? Health - The current health status of the Epic
- started boolean - A true/false boolean indicating if the Epic has been started
- completed boolean - A true/false boolean indicating if the Epic has been completed
- projectIds int[] - The IDs of Projects related to this Epic
- labels LabelSlim[] - An array of Labels attached to the Epic
- objectiveIds int[] - An array of IDs for Objectives to which this epic is related
- completedAt string? - The time/date the Epic was completed
- entityType string - A string description of this resource
- startedAtOverride string? - A manual override for the time/date the Epic was started
- groupId string? -
DeprecatedThe ID of the group to associate with the epic. Usegroup_ids
- name string - The name of the Epic
- plannedStartDate string? - The Epic's planned start date
- startedAt string? - The time/date the Epic was started
- position int - The Epic's relative position in the Epic workflow state
- completedAtOverride string? - A manual override for the time/date the Epic was completed
- ownerIds string[] - An array of UUIDs for any members you want to add as Owners on this new Epic
- mentionIds string[] -
Deprecated:usemember_mention_ids
shortcut: EpicSearchResults
The results of the Epic search query
Fields
- next string? - The URL path and query string for the next page of search results
- total int - The total number of matches for the search query. The first 1000 matches can be paged through via the API
- data EpicSearchResult[] - A list of search results
shortcut: EpicSlim
EpicSlim represents the same resource as an Epic but is more light-weight, including all Epic fields except the comments array. The description string can be optionally included. Use the Get Epic endpoint to fetch the unabridged payload for an Epic
Fields
- requestedById string - The ID of the Member that requested the epic
- productboardName string? - The name of the associated productboard feature
- milestoneId int? -
DeprecatedThe ID of the Objective this Epic is related to. Useobjective_ids
- description? string - The Epic's description
- productboardPluginId string? - The ID of the associated productboard integration
- createdAt string? - The time/date the Epic was created
- groupMentionIds string[] - An array of Group IDs that have been mentioned in the Epic description
- externalId string? - This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here
- archived boolean - True/false boolean that indicates whether the Epic is archived or not
- associatedGroups EpicAssociatedGroup[] - An array containing Group IDs and Group-owned story counts for the Epic's associated groups
- storiesWithoutProjects int - The number of stories in this epic which are not associated with a project
- updatedAt string? - The time/date the Epic was updated
- stats EpicStats - A group of calculated values for this Epic
- epicStateId int - The ID of the Epic State
- productboardUrl string? - The URL of the associated productboard feature
- followerIds string[] - An array of UUIDs for any Members you want to add as Followers on this Epic
- groupIds string[] - An array of UUIDS for Groups to which this Epic is related
- state string -
DeprecatedThe workflow state that the Epic is in
- id int - The unique ID of the Epic
- deadline string? - The Epic's deadline
- memberMentionIds string[] - An array of Member IDs that have been mentioned in the Epic description
- appUrl string - The Shortcut application url for the Epic
- productboardId string? - The ID of the associated productboard feature
- labelIds int[] - An array of Label ids attached to the Epic
- globalId string - The globally unique identifier of the resource
- started boolean - A true/false boolean indicating if the Epic has been started
- completed boolean - A true/false boolean indicating if the Epic has been completed
- projectIds int[] - The IDs of Projects related to this Epic
- labels LabelSlim[] - An array of Labels attached to the Epic
- objectiveIds int[] - An array of IDs for Objectives to which this epic is related
- completedAt string? - The time/date the Epic was completed
- entityType string - A string description of this resource
- startedAtOverride string? - A manual override for the time/date the Epic was started
- groupId string? -
DeprecatedThe ID of the group to associate with the epic. Usegroup_ids
- name string - The name of the Epic
- plannedStartDate string? - The Epic's planned start date
- startedAt string? - The time/date the Epic was started
- position int - The Epic's relative position in the Epic workflow state
- completedAtOverride string? - A manual override for the time/date the Epic was completed
- ownerIds string[] - An array of UUIDs for any members you want to add as Owners on this new Epic
- mentionIds string[] -
Deprecated:usemember_mention_ids
shortcut: EpicState
Epic State is any of the at least 3 columns. Epic States correspond to one of 3 types: Unstarted, Started, or Done
Fields
- entityType string - A string description of this resource
- color? string - The hex color for this Epic State
- updatedAt string - When the Epic State was last updated
- name string - The Epic State's name
- globalId string - The globally unique identifier of the resource
- description string - The description of what sort of Epics belong in that Epic State
- createdAt string - The time/date the Epic State was created
- id int - The unique ID of the Epic State
- position int - The position that the Epic State is in, starting with 0 at the left
- 'type string - The type of Epic State (Unstarted, Started, or Done)
shortcut: EpicStats
A group of calculated values for this Epic
Fields
- lastStoryUpdate string? - The date of the last update of a Story in this Epic
- numPointsDone int - The total number of completed points in this Epic
- numPointsBacklog int - The total number of backlog points in this Epic
- numPointsStarted int - The total number of started points in this Epic
- numStoriesBacklog int - The total number of backlog Stories in this Epic
- numPoints int - The total number of points in this Epic
- numStoriesStarted int - The total number of started Stories in this Epic
- numStoriesUnstarted int - The total number of unstarted Stories in this Epic
- numPointsUnstarted int - The total number of unstarted points in this Epic
- numStoriesUnestimated int - The total number of Stories with no point estimate
- numRelatedDocuments int - The total number of documents associated with this Epic
- numStoriesTotal int - The total number of Stories in this Epic
- numStoriesDone int - The total number of done Stories in this Epic
shortcut: EpicWorkflow
Epic Workflow is the array of defined Epic States. Epic Workflow can be queried using the API but must be updated in the Shortcut UI.
Fields
- entityType string - A string description of this resource
- epicStates EpicState[] - A map of the Epic States in this Epic Workflow
- updatedAt string - The date the Epic Workflow was updated
- createdAt string - The date the Epic Workflow was created
- id int - The unique ID of the Epic Workflow
- defaultEpicStateId int - The unique ID of the default Epic State that new Epics are assigned by default
shortcut: GetDoc
Fields
- contentFormat? "markdown"|"html" - Default content_format: markdown. Format of the content to return. If 'html', includes HTML content in response
shortcut: GetDocQueries
Represents the Queries record for the operation: getDoc
Fields
- contentFormat? "markdown"|"html" - Default content_format: markdown. Format of the content to return. If 'html', includes HTML content in response
shortcut: GetExternalLinkStoriesQueries
Represents the Queries record for the operation: getExternalLinkStories
Fields
- externalLink string - The external link associated with one or more stories
shortcut: GetMemberQueries
Represents the Queries record for the operation: getMember
Fields
- orgPublicId? string - The unique ID of the Organization to limit the lookup to
shortcut: Group
A Group
Fields
- cardAgingMode "off"|"gradual"|"immediate"? - The card aging mode for stories in this Group: "gradual" or "immediate". Null if card aging is off
- mentionName string - The mention name of the Group
- numStories int - The total number of stories assigned to the group
- appUrl string - The Shortcut application url for the Group
- color string? - The hex color to be displayed with the Group (for example, "#ff0000")
- memberIds string[] - The Member IDs contain within the Group
- globalId string - The globally unique identifier of the resource
- description string - The description of the Group
- createdAt string - The instant when this group was created
- cardAgingThresholdDays int? - The number of days an in-progress Story can go without activity before it is considered stale
- numStoriesBacklog int - The number of stories assigned to the group which are in a backlog workflow state
- numStoriesStarted int - The number of stories assigned to the group which are in a started workflow state
- numEpicsStarted int - The number of epics assigned to the group which are in the started workflow state
- workflowIds int[] - The Workflow IDs contained within the Group
- archived boolean - Whether or not the Group is archived
- defaultWorkflowId? int? - The ID of the default workflow for stories created in this group
- entityType string - A string description of this resource
- colorKey "blue"|"purple"|"midnight-blue"|"orange"|"yellow-green"|"brass"|"gray"|"fuchsia"|"yellow"|"pink"|"sky-blue"|"green"|"red"|"black"|"slate"|"turquoise"? - The color key to be displayed with the Group
- updatedAt string - The last instant when this group was updated
- displayIcon Icon - The icon displayed for the entity
- name string - The name of the Group
- id string - The id of the Group
shortcut: Health
The current health status of the Epic
Fields
- entityType string - A string description of this resource
- updatedAt? string - The time that the Health record was updated
- createdAt? string - The time that the Health record was created
- id string? - The unique ID of the Health record
- text? string - The text of the Health record
- authorId? string - The ID of the permission who created or updated the Health record
- epicId? int - The ID of the Epic associated with this Health record
- objectiveId? int - The ID of the Objective associated with this Health record
- status "At Risk"|"On Track"|"Off Track"|"No Health" - The health status of the Epic or Objective
shortcut: History
A history item is a group of actions that represent a transactional change to a Story
Fields
- memberId? string - The ID of the member who performed the change
- automationId? string - The ID of the automation that performed the change
- references? HistoryReferences[] - An array of objects affected by the change. Reference objects provide basic information for the entities reference in the history actions. Some have specific fields, but they always contain an id, entity_type, and a name
- webhookId? string? - The ID of the webhook that handled the change
- actorName? string - The name of the actor that performed the action, if it can be determined
- changedAt string - The date when the change occurred
- externalId? string - The ID of the webhook that handled the change
- id string - The ID representing the change for the story
- actions HistoryActions[] - An array of actions that were performed for the change
- version "v1" - The version of the change format
shortcut: HistoryActionBranchCreate
An action representing a VCS Branch being created
Fields
- entityType string - The type of entity referenced
- name string - The name of the VCS Branch that was pushed
- action "create" - The action of the entity referenced
- id int - The ID of the entity referenced
- url string - The URL from the provider of the VCS Branch that was pushed
shortcut: HistoryActionBranchMerge
An action representing a VCS Branch being merged
Fields
- entityType string - The type of entity referenced
- name string - The name of the VCS Branch that was pushed
- action "merge" - The action of the entity referenced
- id int - The ID of the entity referenced
- url string - The URL from the provider of the VCS Branch that was pushed
shortcut: HistoryActionBranchPush
An action representing a VCS Branch being pushed
Fields
- entityType string - The type of entity referenced
- name string - The name of the VCS Branch that was pushed
- action "push" - The action of the entity referenced
- id int - The ID of the entity referenced
- url string - The URL from the provider of the VCS Branch that was pushed
shortcut: HistoryActionLabelCreate
An action representing a Label being created
Fields
- entityType string - The type of entity referenced
- appUrl string - The application URL of the Label
- name string - The name of the Label
- action "create" - The action of the entity referenced
- id int - The ID of the entity referenced
shortcut: HistoryActionLabelDelete
An action representing a Label being deleted
Fields
- entityType string - The type of entity referenced
- name string - The name of the Label
- action "delete" - The action of the entity referenced
- id int - The ID of the entity referenced
shortcut: HistoryActionLabelUpdate
An action representing a Label being updated
Fields
- entityType string - The type of entity referenced
- action "update" - The action of the entity referenced
- id int - The ID of the entity referenced
shortcut: HistoryActionProjectUpdate
An action representing a Project being updated
Fields
- entityType string - The type of entity referenced
- appUrl string - The application URL of the Project
- name string - The name of the Project
- action "update" - The action of the entity referenced
- id int - The ID of the entity referenced
shortcut: HistoryActionPullRequest
An action representing various operations for a Pull Request
Fields
- number int - The VCS Repository-specific ID for the Pull Request
- entityType string - The type of entity referenced
- action "open"|"update"|"reopen"|"close"|"sync"|"comment" - The action of the entity referenced
- id int - The ID of the entity referenced
- title string - The title of the Pull Request
- url string - The URL from the provider of the VCS Pull Request
shortcut: HistoryActionStoryCommentCreate
An action representing a Story Comment being created
Fields
- entityType string - The type of entity referenced
- appUrl string - The application URL of the Story Comment
- action "create" - The action of the entity referenced
- id int - The ID of the entity referenced
- authorId string - The Member ID of who created the Story Comment
shortcut: HistoryActionStoryCreate
An action representing a Story being created
Fields
- workflowStateId? int - An array of Workflow State IDs attached to the Story
- blocker? boolean - Whether or not the Story is blocking another Story
- requestedById? string - The ID of the Member that requested the Story
- description? string - The description of the Story
- storyType "feature"|"chore"|"bug" - The type of Story; either feature, bug, or chore
- parentStoryId? int - The Story's Parent ID (only applicable if Story is a Sub-task)
- blocked? boolean - Whether or not the Story is blocked by another Story
- projectId? int - The Project ID of the Story is in
- followerIds? string[] - An array of Member IDs for the followers of the Story
- estimate? int - The estimate (or point value) for the Story
- action "create" - The action of the entity referenced
- id int - The ID of the entity referenced
- deadline? string - The timestamp representing the Story's deadline
- subjectStoryLinkIds? int[] - An array of Story IDs that are the subject of a Story Link relationship
- appUrl string - The application URL of the Story
- labelIds? int[] - An array of Labels IDs attached to the Story
- started? boolean - Whether or not the Story has been started
- completed? boolean - Whether or not the Story is completed
- customFieldValueIds? string[] - An array of Custom Field Enum Value ids on this Story
- taskIds? int[] - An array of Task IDs on this Story
- iterationId? int? - The Iteration ID the Story is in
- entityType string - The type of entity referenced
- groupId? string - The Team IDs for the followers of the Story
- name string - The name of the Story
- objectStoryLinkIds? int[] - An array of Story IDs that are the object of a Story Link relationship
- ownerIds? string[] - An array of Member IDs that are the owners of the Story
- epicId? int - The Epic ID for this Story
shortcut: HistoryActionStoryDelete
An action representing a Story being deleted
Fields
- storyType "feature"|"chore"|"bug" - The type of Story; either feature, bug, or chore
- parentStoryId? int - The Story's Parent ID (only applicable if Story is a Sub-task)
- entityType string - The type of entity referenced
- name string - The name of the Story
- action "delete" - The action of the entity referenced
- id int - The ID of the entity referenced
shortcut: HistoryActionStoryLinkCreate
An action representing a Story Link being created
Fields
- subjectId int - The Story ID of the subject Story
- entityType string - The type of entity referenced
- verb "blocks"|"duplicates"|"relates to" - The verb describing the link's relationship
- action "create" - The action of the entity referenced
- id int - The ID of the entity referenced
- objectId int - The Story ID of the object Story
shortcut: HistoryActionStoryLinkDelete
An action representing a Story Link being deleted
Fields
- subjectId int? - The Story ID of the subject Story
- entityType string - The type of entity referenced
- verb "blocks"|"duplicates"|"relates to" - The verb describing the link's relationship
- action "delete" - The action of the entity referenced
- id int - The ID of the entity referenced
- objectId int? - The Story ID of the object Story
shortcut: HistoryActionStoryLinkUpdate
An action representing a Story Link being updated
Fields
- subjectId int - The Story ID of the subject Story
- entityType string - The type of entity referenced
- verb "blocks"|"duplicates"|"relates to" - The verb describing the link's relationship
- changes HistoryChangesStoryLink - The changes that have occurred as a result of the action
- action "update" - The action of the entity referenced
- id int - The ID of the entity referenced
- objectId int - The Story ID of the object Story
shortcut: HistoryActionStoryUpdate
An action representing a Story being updated
Fields
- storyType "feature"|"chore"|"bug" - The type of Story; either feature, bug, or chore
- parentStoryId? int - The Story's Parent ID (only applicable if Story is a Sub-task)
- entityType string - The type of entity referenced
- appUrl string - The application URL of the Story
- changes? HistoryChangesStory - The changes that have occurred as a result of the action
- name string - The name of the Story
- action "update" - The action of the entity referenced
- id int - The ID of the entity referenced
shortcut: HistoryActionTaskCreate
An action representing a Task being created
Fields
- entityType string - The type of entity referenced
- description string - The description of the Task
- action "create" - The action of the entity referenced
- groupMentionIds? string[] - An array of Groups IDs that represent which have been mentioned in the Task
- id int - The ID of the entity referenced
- complete boolean - Whether or not the Task is complete
- deadline? string - A timestamp that represent's the Task's deadline
- ownerIds? string[] - An array of Member IDs that represent the Task's owners
- mentionIds? string[] - An array of Member IDs that represent who has been mentioned in the Task
shortcut: HistoryActionTaskDelete
An action representing a Task being deleted
Fields
- entityType string - The type of entity referenced
- action "delete" - The action of the entity referenced
- description string - The description of the Task being deleted
- id int - The ID of the entity referenced
shortcut: HistoryActionTaskUpdate
An action representing a Task being updated
Fields
- entityType string - The type of entity referenced
- storyId int - The Story ID that contains the Task
- changes HistoryChangesTask - The changes that have occurred as a result of the action
- action "update" - The action of the entity referenced
- description string - The description of the Task
- id int - The ID of the entity referenced
- complete? boolean - Whether or not the Task is complete
shortcut: HistoryActionWorkspace2BulkUpdate
An action representing a bulk operation within a workspace2
Fields
- entityType string - The type of entity referenced
- name string - The name of the workspace2 in which the BulkUpdate occurred
- action "bulk-update" - The action of the entity referenced
- id string - The ID of the entity referenced
shortcut: HistoryChangesStory
The changes that have occurred as a result of the action
Fields
- workflowStateId? StoryHistoryChangeOldNewInt - The change to the workflow state of the story
- blocker? StoryHistoryChangeOldNewBool - True if the Story has archived, otherwise false
- requestedById? StoryHistoryChangeOldNewUuid - The change to the member that requested the story
- commitIds? StoryHistoryChangeAddsRemovesInt - The commits added to or removed from the story
- description? StoryHistoryChangeOldNewStr - A timestamp that represents the Story's deadline
- storyType? StoryHistoryChangeOldNewStr - The change to the type of the story
- archived? StoryHistoryChangeOldNewBool - True if the Story has archived, otherwise false
- parentStoryId? StoryHistoryChangeOldNewInt - The change to the parent story of the story
- blocked? StoryHistoryChangeOldNewBool - True if the Story has archived, otherwise false
- projectId? StoryHistoryChangeOldNewInt - The change to the project of the story
- followerIds? StoryHistoryChangeAddsRemovesUuid - The followers added to or removed from the story
- estimate? StoryHistoryChangeOldNewInt - The estimate value for the Story
- deadline? StoryHistoryChangeOldNewStr - A timestamp that represents the Story's deadline
- subjectStoryLinkIds? StoryHistoryChangeAddsRemovesInt - The story links added to or removed from the story as the subject
- labelIds? StoryHistoryChangeAddsRemovesInt - The labels added to or removed from the story
- started? StoryHistoryChangeOldNewBool - True if the Story has archived, otherwise false
- completed? StoryHistoryChangeOldNewBool - True if the Story has archived, otherwise false
- customFieldValueIds? StoryHistoryChangeAddsRemovesUuid - The custom field values added to or removed from the story
- taskIds? StoryHistoryChangeAddsRemovesInt - The tasks added to or removed from the story
- iterationId? StoryHistoryChangeOldNewInt - The change to the iteration of the story
- groupId? StoryHistoryChangeOldNewUuid - The change to the group of the story
- branchIds? StoryHistoryChangeAddsRemovesInt - The branches added to or removed from the story
- name? StoryHistoryChangeOldNewStr - A timestamp that represents the Story's deadline
- objectStoryLinkIds? StoryHistoryChangeAddsRemovesInt - The story links added to or removed from the story as the object
- ownerIds? StoryHistoryChangeAddsRemovesUuid - Members added to or removed from the owners
- mentionIds? StoryHistoryChangeAddsRemovesUuid - Members added to or removed from the mentions
- epicId? StoryHistoryChangeOldNewInt - The change to the epic of the story
shortcut: HistoryChangesStoryLink
The changes that have occurred as a result of the action
Fields
- subjectId? StoryHistoryChangeOldNewInt - The change to the ID of the subject story of the story link
- verb? StoryHistoryChangeOldNewStr - A timestamp that represents the Story's deadline
- objectId? StoryHistoryChangeOldNewInt - The change to the ID of the object story of the story link
shortcut: HistoryChangesTask
The changes that have occurred as a result of the action
Fields
- description? StoryHistoryChangeOldNewStr - A timestamp that represents the Story's deadline
- complete? StoryHistoryChangeOldNewBool - True if the Story has archived, otherwise false
- ownerIds? StoryHistoryChangeAddsRemovesUuid - Members added to or removed from the owners
- mentionIds? StoryHistoryChangeAddsRemovesUuid - Members added to or removed from the mentions
shortcut: HistoryReferenceBranch
A reference to a VCS Branch
Fields
- entityType string - The type of entity referenced
- name string - The name of the entity referenced
- url string - The external URL for the Branch
shortcut: HistoryReferenceCommit
A reference to a VCS Commit
Fields
- entityType string - The type of entity referenced
- message string - The message from the Commit
- url string - The external URL for the Branch
shortcut: HistoryReferenceCustomFieldEnumValue
A reference to a CustomField value asserted on a Story
Fields
- fieldId string - The public-id of the parent custom-field of this enum value
- entityType string - The type of entity referenced
- stringValue string? - The custom-field enum value as a string
- enumValueEnabled boolean? - Whether or not the custom-field enum value is enabled
- fieldType string - The type variety of the parent custom-field of this enum value
- fieldEnabled boolean - Whether or not the custom-field is enabled
- fieldName string - The name as it is displayed to the user of the parent custom-field of this enum value
shortcut: HistoryReferenceEpic
A reference to an Epic
Fields
- entityType string - The type of entity referenced
- appUrl string - The application URL of the Epic
- name string - The name of the entity referenced
shortcut: HistoryReferenceGeneral
A default reference for entity types that don't have extra fields
Fields
- entityType string - The type of entity referenced
- name string - The name of the entity referenced
shortcut: HistoryReferenceGroup
A reference to a Group
Fields
- entityType string - The type of entity referenced
- name string - The name of the entity referenced
- id string - The ID of the entity referenced
shortcut: HistoryReferenceIteration
A reference to an Iteration
Fields
- entityType string - The type of entity referenced
- appUrl string - The application URL of the Iteration
- name string - The name of the entity referenced
shortcut: HistoryReferenceLabel
A reference to an Label
Fields
- entityType string - The type of entity referenced
- appUrl string - The application URL of the Label
- name string - The name of the entity referenced
shortcut: HistoryReferenceProject
A reference to an Project
Fields
- entityType string - The type of entity referenced
- appUrl string - The application URL of the Project
- name string - The name of the entity referenced
shortcut: HistoryReferenceStory
A reference to a Story
Fields
- storyType "feature"|"chore"|"bug" - If the referenced entity is a Story, either "bug", "chore", or "feature"
- parentStoryId? int - The Story's Parent ID (only applicable if Story is a Sub-task)
- entityType string - The type of entity referenced
- appUrl string - The application URL of the Story
- name string - The name of the entity referenced
shortcut: HistoryReferenceStoryTask
A reference to a Story Task
Fields
- entityType string - The type of entity referenced
- description string - The description of the Story Task
shortcut: HistoryReferenceWorkflowState
A references to a Story Workflow State
Fields
- entityType string - The type of entity referenced
- name string - The name of the entity referenced
- 'type "started"|"backlog"|"unstarted"|"done" - Either "backlog", "unstarted", "started", or "done"
shortcut: Icon
Icons are used to attach images to Groups, Workspaces, Members, and Loading screens in the Shortcut web application
Fields
- entityType string - A string description of this resource
- updatedAt string - The time/date that the Icon was updated
- createdAt string - The time/date that the Icon was created
- id string - The unique ID of the Icon
- url string - The URL of the Icon
shortcut: Identity
The Identity of the VCS user that authored the Commit
Fields
- entityType string - A string description of this resource
- name string? - This is your login in VCS
- 'type "slack"|"github"|"gitlab"|"bitbucket"? - The service this Identity is for
shortcut: Iteration
An Iteration is a defined, time-boxed period of development for a collection of Stories. See https://help.shortcut.com/hc/en-us/articles/360028953452-Iterations-Overview for more information
Fields
- memberMentionIds string[] - An array of Member IDs that have been mentioned in the Story description
- endDate string - The date this iteration ends
- appUrl string - The Shortcut application url for the Iteration
- labelIds int[] - An array of label ids attached to the iteration
- globalId string - The globally unique identifier of the resource
- description string - The description of the iteration
- createdAt string - The instant when this iteration was created
- groupMentionIds string[] - An array of Group IDs that have been mentioned in the Story description
- labels Label[] - An array of labels attached to the iteration
- entityType string - A string description of this resource
- associatedGroups IterationAssociatedGroup[] - An array containing Group IDs and Group-owned story counts for the Iteration's associated groups
- updatedAt string - The instant when this iteration was last updated
- stats IterationStats - A group of calculated values for this Iteration
- followerIds string[] - An array of UUIDs for any Members listed as Followers
- name string - The name of the iteration
- groupIds string[] - An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI
- id int - The ID of the iteration
- mentionIds string[] -
Deprecated:usemember_mention_ids
- startDate string - The date this iteration begins
- status string - The status of the iteration. Values are either "unstarted", "started", or "done"
shortcut: IterationAssociatedGroup
Fields
- groupId string - The Group ID of the associated group
- associatedStoriesCount? int - The number of stories this Group owns in the Iteration
shortcut: IterationSearchResults
The results of the Iteration search query
Fields
- next string? - The URL path and query string for the next page of search results
- total int - The total number of matches for the search query. The first 1000 matches can be paged through via the API
- data IterationSlim[] - A list of search results
shortcut: IterationSlim
IterationSlim represents the same resource as an Iteration, but is more light-weight. Use the Get Iteration endpoint to fetch the unabridged payload for an Iteration.
Fields
- memberMentionIds string[] - An array of Member IDs that have been mentioned in the Story description
- endDate string - The date this iteration ends
- appUrl string - The Shortcut application url for the Iteration
- labelIds int[] - An array of label ids attached to the iteration
- globalId string - The globally unique identifier of the resource
- createdAt string - The instant when this iteration was created
- groupMentionIds string[] - An array of Group IDs that have been mentioned in the Story description
- labels Label[] - An array of labels attached to the iteration
- entityType string - A string description of this resource
- associatedGroups IterationAssociatedGroup[] - An array containing Group IDs and Group-owned story counts for the Iteration's associated groups
- updatedAt string - The instant when this iteration was last updated
- stats IterationStats - A group of calculated values for this Iteration
- followerIds string[] - An array of UUIDs for any Members listed as Followers
- name string - The name of the iteration
- groupIds string[] - An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI
- id int - The ID of the iteration
- mentionIds string[] -
Deprecated:usemember_mention_ids
- startDate string - The date this iteration begins
- status string - The status of the iteration. Values are either "unstarted", "started", or "done"
shortcut: IterationStats
A group of calculated values for this Iteration
Fields
- averageCycleTime? int - The average cycle time (in seconds) of completed stories in this Iteration
- numPointsDone int - The total number of completed points in this Iteration
- numPointsBacklog int - The total number of backlog points in this Iteration
- numPointsStarted int - The total number of started points in this Iteration
- numStoriesBacklog int - The total number of backlog Stories in this Iteration
- numPoints int - The total number of points in this Iteration
- numStoriesStarted int - The total number of started Stories in this Iteration
- numStoriesUnstarted int - The total number of unstarted Stories in this Iteration
- numPointsUnstarted int - The total number of unstarted points in this Iteration
- numStoriesUnestimated int - The total number of Stories with no point estimate
- numRelatedDocuments int - The total number of documents related to an Iteration
- numStoriesDone int - The total number of done Stories in this Iteration
- averageLeadTime? int - The average lead time (in seconds) of completed stories in this Iteration
shortcut: KeyResult
Fields
- currentTargetValue KeyResultValue -
- name string - The name of the Key Result
- progress int - The integer percentage of progress toward completion of the Key Result
- currentObservedValue KeyResultValue -
- id string - The ID of the Key Result
- 'type "percent"|"boolean"|"numeric" - The type of the Key Result (numeric, percent, or boolean)
- objectiveId int - The Objective to which this Key Result belongs
- initialObservedValue KeyResultValue -
shortcut: KeyResultValue
The starting value of the Key Result
Fields
- numericValue? string - The numeric value, as a decimal string. No more than two decimal places are allowed
- booleanValue? boolean - The boolean value
shortcut: Label
A Label can be used to associate and filter Stories and Epics, and also create new Workspaces
Fields
- archived boolean - A true/false boolean indicating if the Label has been archived
- appUrl string - The Shortcut application url for the Label
- entityType string - A string description of this resource
- color string? - The hex color to be displayed with the Label (for example, "#ff0000")
- updatedAt string? - The time/date that the Label was updated
- stats? LabelStats - A group of calculated values for this Label. This is not included if the slim? flag is set to true for the List Labels endpoint
- name string - The name of the Label
- globalId string - The globally unique identifier of the resource
- description string? - The description of the Label
- createdAt string? - The time/date that the Label was created
- externalId string? - This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here
- id int - The unique ID of the Label
shortcut: LabelSlim
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 using the labels endpoint to retrieve them
Fields
- archived boolean - A true/false boolean indicating if the Label has been archived
- appUrl string - The Shortcut application url for the Label
- entityType string - A string description of this resource
- color string? - The hex color to be displayed with the Label (for example, "#ff0000")
- updatedAt string? - The time/date that the Label was updated
- name string - The name of the Label
- globalId string - The globally unique identifier of the resource
- description string? - The description of the Label
- createdAt string? - The time/date that the Label was created
- externalId string? - This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here
- id int - The unique ID of the Label
shortcut: LabelStats
A group of calculated values for this Label. This is not included if the slim? flag is set to true for the List Labels endpoint
Fields
- numEpicsTotal int - The total number of Epics associated with this Label
- numEpicsInProgress int - The number of in progress epics associated with this label
- numPointsBacklog int - The total number of backlog points with this Label
- numEpics int - The total number of Epics with this Label
- numPointsCompleted int - The total number of completed points with this Label
- numStoriesBacklog int - The total number of stories backlog Stories with this Label
- numEpicsUnstarted int - The number of unstarted epics associated with this label
- numPointsInProgress int - The total number of in-progress points with this Label
- numStoriesUnstarted int - The total number of stories unstarted Stories with this Label
- numPointsUnstarted int - The total number of unstarted points with this Label
- numStoriesUnestimated int - The total number of Stories with no point estimate with this Label
- numPointsTotal int - The total number of points with this Label
- numRelatedDocuments int - The total number of Documents associated this Label
- numStoriesInProgress int - The total number of in-progress Stories with this Label
- numStoriesCompleted int - The total number of completed Stories with this Label
- numStoriesTotal int - The total number of Stories with this Label
- numEpicsCompleted int - The number of completed Epics associated with this Label
shortcut: LinkedFile
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, and by URL
Fields
- memberMentionIds string[] - The members that are mentioned in the description of the file
- uploaderId string - The UUID of the member that uploaded the file
- description string? - The description of the file
- createdAt string - The time/date the LinkedFile was created
- groupMentionIds string[] - The groups that are mentioned in the description of the file
- thumbnailUrl string? - The URL of the file thumbnail, if the integration provided it
- 'type string - The integration type (e.g. google, dropbox, box)
- url string - The URL of the file
- entityType string - A string description of this resource
- size int? - The filesize, if the integration provided it
- contentType string? - The content type of the image (e.g. txt/plain)
- updatedAt string - The time/date the LinkedFile was updated
- storyIds int[] - The IDs of the stories this file is attached to
- name string - The name of the linked file
- id int - The unique identifier for the file
- mentionIds string[] -
Deprecated:usemember_mention_ids
shortcut: LinkSubTaskParams
Fields
- storyId int - The ID of the story to link as a sub-task of the parent story
shortcut: ListEpicsPaginatedQueries
Represents the Queries record for the operation: listEpicsPaginated
Fields
- includesDescription? boolean - A true/false boolean indicating whether to return Epics with their descriptions
- page? int - The page number to return, starting with 1. Defaults to 1
- pageSize? int - The number of Epics to return per page. Minimum 1, maximum 250, default 10
shortcut: ListEpicsQueries
Represents the Queries record for the operation: listEpics
Fields
- includesDescription? boolean - A true/false boolean indicating whether to return Epics with their descriptions
shortcut: ListEpicStoriesQueries
Represents the Queries record for the operation: listEpicStories
Fields
- includesDescription? boolean - A true/false boolean indicating whether to return Stories with their descriptions
shortcut: ListGroupsQueries
Represents the Queries record for the operation: listGroups
Fields
- archived? boolean - Filter groups by their archived state. If true, returns only archived groups. If false, returns only unarchived groups. If not provided, returns all groups
shortcut: ListGroupStoriesQueries
Represents the Queries record for the operation: listGroupStories
Fields
- offset? int - The offset at which to begin returning results. (Defaults to 0)
- 'limit? int - The maximum number of results to return. (Defaults to 1000, max 1000)
shortcut: ListIterationStoriesQueries
Represents the Queries record for the operation: listIterationStories
Fields
- includesDescription? boolean - A true/false boolean indicating whether to return Stories with their descriptions
shortcut: ListLabelsQueries
Represents the Queries record for the operation: listLabels
Fields
- slim? boolean - A true/false boolean indicating if the slim versions of the Label should be returned
shortcut: ListLabelStoriesQueries
Represents the Queries record for the operation: listLabelStories
Fields
- includesDescription? boolean - A true/false boolean indicating whether to return Stories with their descriptions
shortcut: ListMembersQueries
Represents the Queries record for the operation: listMembers
Fields
- orgPublicId? string - The unique ID of the Organization to limit the list to
- disabled? boolean - Filter members by their disabled state. If true, return only disabled members. If false, return only enabled members
shortcut: ListStoriesQueries
Represents the Queries record for the operation: listStories
Fields
- includesDescription? boolean - A true/false boolean indicating whether to return Stories with their descriptions
shortcut: Member
Details about an individual user within the Workspace
Fields
- role string - The Member's role in the Workspace
- profile Profile - A group of Member profile details
- globalId string - The globally unique identifier of the resource
- installationId? string - Only set for agents. The installation id associated with this agent
- createdAt string? - The time/date the Member was created
- replacedBy? string - The id of the member that replaces this one when merged
- entityType string - A string description of this resource
- updatedAt string? - The time/date the Member was last updated
- groupIds string[] - The Member's group ids
- disabled boolean - True/false boolean indicating whether the Member has been disabled within the Workspace
- state "partial"|"full"|"disabled"|"imported" - The user state, one of partial, full, disabled, or imported. A partial user is disabled, has no means to log in, and is not an import user. A full user is enabled and has a means to log in. A disabled user is disabled and has a means to log in. An import user is disabled, has no means to log in, and is marked as an import user
- id string - The Member's ID in Shortcut
- createdWithoutInvite boolean - Whether this member was created as a placeholder entity
shortcut: MemberInfo
Fields
- mentionName string -
- role string -
- isOwner boolean -
- organization2 MemberInfoOrganization -
- name string -
- workspace2 BasicWorkspaceInfo -
- id string -
shortcut: MemberInfoOrganization
Fields
- id string -
shortcut: Milestone
(Deprecated) A Milestone is a collection of Epics that represent a release or some other large initiative that you are working on. Milestones have become Objectives, so you should use Objective-related API resources instead of Milestone ones
Fields
- appUrl string - The Shortcut application url for the Milestone
- globalId string - The globally unique identifier of the resource
- description string - The Milestone's description
- createdAt string - The time/date the Milestone was created
- started boolean - A true/false boolean indicating if the Milestone has been started
- completed boolean - A true/false boolean indicating if the Milestone has been completed
- archived boolean - A boolean indicating whether the Milestone has been archived or not
- completedAt string? - The time/date the Milestone was completed
- entityType string - A string description of this resource
- startedAtOverride string? - A manual override for the time/date the Milestone was started
- updatedAt string - The time/date the Milestone was updated
- stats MilestoneStats - A group of calculated values for this Milestone
- name string - The name of the Milestone
- startedAt string? - The time/date the Milestone was started
- state string - The workflow state that the Milestone is in
- categories Category[] - An array of Categories attached to the Milestone
- id int - The unique ID of the Milestone
- position int - A number representing the position of the Milestone in relation to every other Milestone within the Workspace
- completedAtOverride string? - A manual override for the time/date the Milestone was completed
- keyResultIds string[] - The IDs of the Key Results associated with the Objective
shortcut: MilestoneStats
A group of calculated values for this Milestone
Fields
- averageCycleTime? int - The average cycle time (in seconds) of completed stories in this Milestone
- numRelatedDocuments int - The number of related documents to this Milestone
- averageLeadTime? int - The average lead time (in seconds) of completed stories in this Milestone
shortcut: Objective
An Objective is a collection of Epics that represent a release or some other large initiative that you are working on
Fields
- appUrl string - The Shortcut application url for the Objective
- globalId string - The globally unique identifier of the resource
- description string - The Objective's description
- createdAt string - The time/date the Objective was created
- started boolean - A true/false boolean indicating if the Objective has been started
- completed boolean - A true/false boolean indicating if the Objectivehas been completed
- archived boolean - A boolean indicating whether the Objective has been archived or not
- completedAt string? - The time/date the Objective was completed
- entityType string - A string description of this resource
- startedAtOverride string? - A manual override for the time/date the Objective was started
- updatedAt string - The time/date the Objective was updated
- stats ObjectiveStats - A group of calculated values for this Objective
- name string - The name of the Objective
- startedAt string? - The time/date the Objective was started
- state string - The workflow state that the Objective is in
- categories Category[] - An array of Categories attached to the Objective
- id int - The unique ID of the Objective
- position int - A number representing the position of the Objective in relation to every other Objective within the Workspace
- completedAtOverride string? - A manual override for the time/date the Objective was completed
- keyResultIds string[] - The IDs of the Key Results associated with the Objective
shortcut: ObjectiveSearchResult
A Milestone in search results. This is typed differently from Milestone because the details=slim search argument will omit some fields
Fields
- appUrl string - The Shortcut application url for the Milestone
- globalId string - The globally unique identifier of the resource
- description? string - The Milestone's description
- createdAt string - The time/date the Milestone was created
- started boolean - A true/false boolean indicating if the Milestone has been started
- completed boolean - A true/false boolean indicating if the Milestone has been completed
- archived boolean - A boolean indicating whether the Milestone has been archived or not
- completedAt string? - The time/date the Milestone was completed
- entityType string - A string description of this resource
- startedAtOverride string? - A manual override for the time/date the Milestone was started
- updatedAt string - The time/date the Milestone was updated
- stats MilestoneStats - A group of calculated values for this Milestone
- name string - The name of the Milestone
- startedAt string? - The time/date the Milestone was started
- state string - The workflow state that the Milestone is in
- categories Category[] - An array of Categories attached to the Milestone
- id int - The unique ID of the Milestone
- position int - A number representing the position of the Milestone in relation to every other Milestone within the Workspace
- completedAtOverride string? - A manual override for the time/date the Milestone was completed
- keyResultIds string[] - The IDs of the Key Results associated with the Objective
shortcut: ObjectiveSearchResults
The results of the Objective search query
Fields
- next string? - The URL path and query string for the next page of search results
- total int - The total number of matches for the search query. The first 1000 matches can be paged through via the API
- data ObjectiveSearchResult[] - A list of search results
shortcut: ObjectiveStats
A group of calculated values for this Objective
Fields
- averageCycleTime? int - The average cycle time (in seconds) of completed stories in this Objective
- numRelatedDocuments int - The number of related documents to this Objective
- averageLeadTime? int - The average lead time (in seconds) of completed stories in this Objective
shortcut: Profile
A group of Member profile details
Fields
- mentionName string - The Member's username within the Organization
- isOwner boolean - A boolean indicating whether this profile is an owner at their associated organization
- deactivated boolean - A true/false boolean indicating whether the Member has been deactivated within Shortcut
- isAssignable? boolean - For an Agent: whether it may be set as an owner on Stories and Epics
- isMentionable? boolean - For an Agent: whether it may be @-mentioned in comments and descriptions
- gravatarHash string? - This is the gravatar hash associated with email_address
- entityType string - A string description of this resource
- emailAddress string? - The primary email address of the Member with the Organization
- displayIcon Icon - The icon displayed for the entity
- name string? - The Member's name within the Organization
- isAgent? boolean - Whether this profile is an Agent/Bot user
- id string - The unique identifier of the profile
- twoFactorAuthActivated? boolean - If Two Factor Authentication is activated for this User
shortcut: Project
Projects typically map to teams (such as Frontend, Backend, Mobile, Devops, etc) but can represent any open-ended product, component, or initiative
Fields
- daysToThermometer int - The number of days before the thermometer appears in the Story summary
- workflowId int - The ID of the workflow the project belongs to
- showThermometer boolean - Configuration to enable or disable thermometers in the Story summary
- appUrl string - The Shortcut application url for the Project
- color string? - The color associated with the Project in the Shortcut member interface
- globalId string - The Global ID of the Project
- description string? - The description of the Project
- createdAt string? - The time/date that the Project was created
- externalId string? - This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here
- teamId int - The ID of the team the project belongs to
- abbreviation string? - The Project abbreviation used in Story summaries. Should be kept to 3 characters at most
- archived boolean - True/false boolean indicating whether the Project is in an Archived state
- startTime string - The date at which the Project was started
- entityType string - A string description of this resource
- updatedAt string? - The time/date that the Project was last updated
- stats ProjectStats - A group of calculated values for this Project
- followerIds string[] - An array of UUIDs for any Members listed as Followers
- name string - The name of the Project
- id int - The unique ID of the Project
- iterationLength int - The number of weeks per iteration in this Project
shortcut: ProjectStats
A group of calculated values for this Project
Fields
- numStories int - The total number of stories in this Project
- numRelatedDocuments int - The total number of documents related to this Project
- numPoints int - The total number of points in this Project
shortcut: PullRequest
Corresponds to a VCS Pull Request attached to a Shortcut story
Fields
- vcsLabels? PullRequestLabel[]? - An array of PullRequestLabels attached to the PullRequest
- targetBranchName string - The name of the target branch for the particular pull request
- merged boolean - True/False boolean indicating whether the VCS pull request has been merged
- createdAt string - The time/date the pull request was created
- title string - The title of the pull request
- numCommits int? - The number of commits on the pull request
- url string - The URL for the pull request
- overlappingStories? int[] - An array of Story ids that have Pull Requests that change at least one of the same lines this Pull Request changes
- hasOverlappingStories boolean - Boolean indicating that the Pull Request has Stories that have Pull Requests that change at least one of the same lines this Pull Request changes
- number int - The pull request's unique number ID in VCS
- entityType string - A string description of this resource
- updatedAt string - The time/date the pull request was created
- branchId int - The ID of the branch for the particular pull request
- branchName string - The name of the branch for the particular pull request
- draft boolean - True/False boolean indicating whether the VCS pull request is in the draft state
- numModified int? - Number of lines modified in the pull request, according to VCS
- targetBranchId int - The ID of the target branch for the particular pull request
- closed boolean - True/False boolean indicating whether the VCS pull request has been closed
- repositoryId int - The ID of the repository for the particular pull request
- id int - The unique ID associated with the pull request in Shortcut
- numRemoved int - Number of lines removed in the pull request, according to VCS
- reviewStatus? string - The status of the review for the pull request
- buildStatus? string - The status of the Continuous Integration workflow for the pull request
- numAdded int - Number of lines added in the pull request, according to VCS
shortcut: PullRequestLabel
Corresponds to a VCS Label associated with a Pull Request
Fields
- entityType string - A string description of this resource
- color string - The color of the VCS label
- name string - The name of the VCS label
- description? string? - The description of the VCS label
- id int - The unique ID of the VCS Label
shortcut: RemoveCustomFieldParams
Fields
- fieldId string - The unique public ID for the CustomField
shortcut: RemoveLabelParams
Request parameters for removing a Label from a Shortcut Story
Fields
- name string - The name of the new Label to remove
shortcut: Repository
Repository refers to a VCS repository
Fields
- entityType string - A string description of this resource
- fullName string? - The full name of the VCS repository
- updatedAt string? - The time/date the Repository was updated
- name string? - The shorthand name of the VCS repository
- createdAt string? - The time/date the Repository was created
- externalId string? - The VCS unique identifier for the Repository
- id int? - The ID associated to the VCS repository in Shortcut
- 'type "github"|"gitlab"|"bitbucket" - The VCS provider for the Repository
- url string? - The URL of the Repository
shortcut: SearchDocumentsQueries
Represents the Queries record for the operation: searchDocuments
Fields
- next? string - The next page token
- archived? boolean - When true, find archived documents. When false, find non-archived documents
- followedByMe? boolean - When true, find documents that the current user is following. When false, find documents NOT followed
- title string - Search text to match against document titles. Supports fuzzy matching. Required
- createdByMe? boolean - When true, find documents created by the current user. When false, find documents NOT created by current user
- pageSize? int - The number of search results to include in a page. Minimum of 1 and maximum of 250
shortcut: SearchEpicsQueries
Represents the Queries record for the operation: searchEpics
Fields
- next? string - The next page token
- query string - See our help center article on search operators
- entityTypes? ("story"|"milestone"|"epic"|"iteration"|"objective")[] - A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story
- detail? "full"|"slim" - The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full"
- pageSize? int - The number of search results to include in a page. Minimum of 1 and maximum of 250
shortcut: SearchIterationsQueries
Represents the Queries record for the operation: searchIterations
Fields
- next? string - The next page token
- query string - See our help center article on search operators
- entityTypes? ("story"|"milestone"|"epic"|"iteration"|"objective")[] - A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story
- detail? "full"|"slim" - The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full"
- pageSize? int - The number of search results to include in a page. Minimum of 1 and maximum of 250
shortcut: SearchMilestonesQueries
Represents the Queries record for the operation: searchMilestones
Fields
- next? string - The next page token
- query string - See our help center article on search operators
- entityTypes? ("story"|"milestone"|"epic"|"iteration"|"objective")[] - A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story
- detail? "full"|"slim" - The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full"
- pageSize? int - The number of search results to include in a page. Minimum of 1 and maximum of 250
shortcut: SearchObjectivesQueries
Represents the Queries record for the operation: searchObjectives
Fields
- next? string - The next page token
- query string - See our help center article on search operators
- entityTypes? ("story"|"milestone"|"epic"|"iteration"|"objective")[] - A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story
- detail? "full"|"slim" - The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full"
- pageSize? int - The number of search results to include in a page. Minimum of 1 and maximum of 250
shortcut: SearchQueries
Represents the Queries record for the operation: search
Fields
- next? string - The next page token
- query string - See our help center article on search operators
- entityTypes? ("story"|"milestone"|"epic"|"iteration"|"objective")[] - A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story
- detail? "full"|"slim" - The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full"
- pageSize? int - The number of search results to include in a page. Minimum of 1 and maximum of 250
shortcut: SearchResults
The results of the multi-entity search query
Fields
- stories? StorySearchResults - The results of the Story search query
- milestones? ObjectiveSearchResults - The results of the Objective search query
- epics? EpicSearchResults - The results of the Epic search query
- iterations? IterationSearchResults - The results of the Iteration search query
shortcut: SearchStories
Fields
- workflowStateId? int - The unique IDs of the specific Workflow States that the Stories should be in
- includesDescription? boolean - Whether to include the story description in the response
- completedAtStart? string - Stories should have been completed on or after this date
- requestedById? string - The UUID of any Users who may have requested the Stories
- ownerId? string? - An array of UUIDs for any Users who may be Owners of the Stories
- externalId? string - An ID or URL that references an external resource. Useful during imports
- workflowStateTypes? ("started"|"backlog"|"unstarted"|"done")[] - The type of Workflow State the Stories may be in
- storyType? "feature"|"chore"|"bug" - The type of Stories that you want returned
- archived? boolean - A true/false boolean indicating whether the Story is in archived state
- updatedAtStart? string - Stories should have been updated on or after this date
- createdAtStart? string - Stories should have been created on or after this date
- projectId? int? - The IDs for the Projects the Stories may be assigned to
- groupIds? string[] - The Group IDs that are associated with the Stories
- estimate? int - The number of estimate points associate with the Stories
- createdAtEnd? string - Stories should have been created on or before this date
- labelName? string - The name of any associated Labels
- iterationIds? int[] - The Iteration IDs that may be associated with the Stories
- epicIds? int[] - The Epic IDs that may be associated with the Stories
- labelIds? int[] - The Label IDs that may be associated with the Stories
- projectIds? int[] - The IDs for the Projects the Stories may be assigned to
- updatedAtEnd? string - Stories should have been updated on or before this date
- iterationId? int? - The Iteration ID that may be associated with the Stories
- groupId? string? - The Group ID that is associated with the Stories
- completedAtEnd? string - Stories should have been completed on or before this date
- deadlineEnd? string - Stories should have a deadline on or before this date
- ownerIds? string[] - An array of UUIDs for any Users who may be Owners of the Stories
- epicId? int? - The Epic IDs that may be associated with the Stories
- deadlineStart? string - Stories should have a deadline on or after this date
shortcut: SearchStoriesQueries
Represents the Queries record for the operation: searchStories
Fields
- next? string - The next page token
- query string - See our help center article on search operators
- entityTypes? ("story"|"milestone"|"epic"|"iteration"|"objective")[] - A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story
- detail? "full"|"slim" - The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full"
- pageSize? int - The number of search results to include in a page. Minimum of 1 and maximum of 250
shortcut: Story
Stories are the standard unit of work in Shortcut and represent individual features, bugs, and chores
Fields
- workflowStateId int - The ID of the workflow state the story is currently in
- workflowId int - The ID of the workflow the story belongs to
- requestedById string - The ID of the Member that requested the story
- pullRequests PullRequest[] - An array of Pull/Merge Requests attached to the story
- storyTemplateId string? - The ID of the story template used to create this story, or null if not created using a template
- projectId int? - The ID of the project the story belongs to
- stats StoryStats - The stats object for Stories
- estimate int? - The numeric point estimate of the story. Can also be null, which means unestimated
- id int - The unique ID of the Story
- tasks Task[] - An array of tasks connected to the story
- subTaskStoryIds? int[] - The Story IDs of Sub-tasks attached to the Story Field only applicable when Sub-task feature is enabled
- customFields? StoryCustomField[] - An array of CustomField value assertions for the story
- formattedVcsBranchName? string? - The formatted branch name for this story
- labelIds int[] - An array of label ids attached to the story
- globalId string - The globally unique identifier of the resource
- completed boolean - A true/false boolean indicating if the Story has been completed
- branches Branch[] - An array of Git branches attached to the story
- labels LabelSlim[] - An array of labels attached to the story
- iterationId int? - The ID of the iteration the story belongs to
- completedAt string? - The time/date the Story was completed
- previousIterationIds int[] - The IDs of the iteration the story belongs to
- externalLinks string[] - An array of external links (strings) associated with a Story
- name string - The name of the story
- startedAt string? - The time/date the Story was started
- commits Commit[] - An array of commits attached to the story
- files UploadedFile[] - An array of files attached to the story
- cycleTime? int - The cycle time (in seconds) of this story when complete
- position int - A number representing the position of the story in relation to every other story in the current project
- completedAtOverride string? - A manual override for the time/date the Story was completed
- ownerIds string[] - An array of UUIDs of the owners of this story
- mentionIds string[] -
Deprecated:usemember_mention_ids
- blocker boolean - A true/false boolean indicating if the Story is currently a blocker of another story
- linkedFiles LinkedFile[] - An array of linked files attached to the story
- description string - The description of the story
- createdAt string - The time/date the Story was created
- groupMentionIds string[] - An array of Group IDs that have been mentioned in the Story description
- externalId string? - 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
- storyType string - The type of story (feature, bug, chore)
- archived boolean - True if the story has been archived or not
- parentStoryId? int? - The ID of the parent story to this story (making this story a sub-task). Field only applicable when Sub-task feature is enabled
- updatedAt string? - The time/date the Story was updated
- blocked boolean - A true/false boolean indicating if the Story is currently blocked
- followerIds string[] - An array of UUIDs for any Members listed as Followers
- leadTime? int - The lead time (in seconds) of this story when complete
- deadline string? - The due date of the story
- memberMentionIds string[] - An array of Member IDs that have been mentioned in the Story description
- appUrl string - The Shortcut application url for the Story
- comments StoryComment[] - An array of comments attached to the story
- storyLinks TypedStoryLink[] - An array of story links attached to the Story
- started boolean - A true/false boolean indicating if the Story has been started
- syncedItem? SyncedItem - The external application the story is synced with
- movedAt string? - The time/date the Story was last changed workflow-state
- entityType string - A string description of this resource
- startedAtOverride string? - A manual override for the time/date the Story was started
- groupId string? - The ID of the group associated with the story
- epicId int? - The ID of the epic the story belongs to
shortcut: StoryComment
A Comment is any note added within the Comment field of a Story
Fields
- memberMentionIds string[] - The unique IDs of the Member who are mentioned in the Comment
- blocker? boolean - Marks the comment as a blocker that can be surfaced to permissions or teams mentioned in the comment. Can only be used on a top-level comment
- appUrl string - The Shortcut application url for the Comment
- storyId int - The ID of the Story on which the Comment appears
- createdAt string - The time/date when the Comment was created
- groupMentionIds string[] - The unique IDs of the Group who are mentioned in the Comment
- externalId string? - This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here
- unblocksParent? boolean - Marks the comment as an unblocker to its blocker parent. Can only be set on a threaded comment who has a parent with
blockerset
- entityType string - A string description of this resource
- deleted boolean - True/false boolean indicating whether the Comment has been deleted
- updatedAt string? - The time/date when the Comment was updated
- linkedToSlack boolean - Whether the Comment is currently the root of a thread that is linked to Slack
- parentId? int? - The ID of the parent Comment this Comment is threaded under
- reactions StoryReaction[] - A set of Reactions to this Comment
- id int - The unique ID of the Comment
- position int - The Comments numerical position in the list from oldest to newest
- text string? - The text of the Comment. In the case that the Comment has been deleted, this field can be set to nil
- authorId string? - The unique ID of the Member who is the Comment's author
- mentionIds string[] -
Deprecated:usemember_mention_ids
shortcut: StoryContents
A container entity for the attributes this template should populate
Fields
- workflowStateId? int - The ID of the workflow state the story is currently in
- customFields? CustomFieldValueParams[] - An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField
- labelIds? int[] - An array of label ids attached to the story
- linkedFiles? LinkedFile[] - An array of linked files attached to the story
- description? string - The description of the story
- labels? LabelSlim[] - An array of labels attached to the story
- iterationId? int - The ID of the iteration the story belongs to
- storyType? string - The type of story (feature, bug, chore)
- entityType? string - A string description of this resource
- groupId? string - The ID of the group to which the story is assigned
- projectId? int - The ID of the project the story belongs to
- externalLinks? string[] - An array of external links connected to the story
- followerIds? string[] - An array of UUIDs for any Members listed as Followers
- name? string - The name of the story
- estimate? int - The numeric point estimate of the story. Can also be null, which means unestimated
- subTasks? CreateSubTaskParams[] - An array of maps specifying the sub-tasks to create and link to the story. Field only applicable when Sub-task feature is enabled
- files? UploadedFile[] - An array of files attached to the story
- deadline? string - The due date of the story
- tasks? StoryContentsTask[] - An array of tasks connected to the story
- ownerIds? string[] - An array of UUIDs of the owners of this story
- epicId? int - The ID of the epic the story belongs to
shortcut: StoryContentsTask
Fields
- description string - Full text of the Task
- externalId? string? - This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here
- position? int - The number corresponding to the Task's position within a list of Tasks on a Story
- complete? boolean - True/false boolean indicating whether the Task has been completed
- ownerIds? string[] - An array of UUIDs of the Owners of this Task
shortcut: StoryCustomField
Fields
- fieldId string - The unique public ID for a CustomField
- valueId string - The unique public ID for a CustomFieldEnumValue
- value string - A string representation of the value, if applicable
shortcut: StoryHistoryChangeAddsRemovesInt
Task IDs that have been added or removed from the Story
Fields
- removes? int[] - The values that have been removed
- adds? int[] - The values that have been added
shortcut: StoryHistoryChangeAddsRemovesUuid
Custom Field Enum Value IDs that have been added or removed from the Story
Fields
- removes? string[] - The values that have been removed
- adds? string[] - The values that have been added
shortcut: StoryHistoryChangeOldNewBool
True if the Story has archived, otherwise false
Fields
- 'new? boolean - The new value
- old? boolean - The old value
shortcut: StoryHistoryChangeOldNewInt
The estimate value for the Story
Fields
- 'new? int - The new value
- old? int - The old value
shortcut: StoryHistoryChangeOldNewStr
A timestamp that represents the Story's deadline
Fields
- 'new? string - The new value
- old? string? - The old value
shortcut: StoryHistoryChangeOldNewUuid
The Team ID for the Story
Fields
- 'new? string - The new value
- old? string - The old value
shortcut: StoryLink
Story links allow you create semantic relationships between two stories. Relationship types are relates to, blocks / blocked by, and duplicates / is duplicated by. The format is subject -> link -> object, or for example "story 5 blocks story 6"
Fields
- subjectId int - The ID of the subject Story
- entityType string - A string description of this resource
- updatedAt string - The time/date when the Story Link was last updated
- subjectWorkflowStateId int - The workflow state of the "subject" story
- verb string - How the subject Story acts on the object Story. This can be "blocks", "duplicates", or "relates to"
- createdAt string - The time/date when the Story Link was created
- id int - The unique identifier of the Story Link
- objectId int - The ID of the object Story
shortcut: StoryReaction
Emoji reaction on a comment
Fields
- emoji string - Emoji text of the reaction
- permissionIds string[] - Permissions who have reacted with this
shortcut: StorySearchResult
A Story in search results. This is typed differently from Story because the details=slim search argument will omit some fields
Fields
- workflowStateId int - The ID of the workflow state the story is currently in
- workflowId int - The ID of the workflow the story belongs to
- requestedById string - The ID of the Member that requested the story
- pullRequests? PullRequest[] - An array of Pull/Merge Requests attached to the story
- storyTemplateId string? - The ID of the story template used to create this story, or null if not created using a template
- projectId int? - The ID of the project the story belongs to
- stats StoryStats - The stats object for Stories
- estimate int? - The numeric point estimate of the story. Can also be null, which means unestimated
- id int - The unique ID of the Story
- tasks? Task[] - An array of tasks connected to the story
- subTaskStoryIds? int[] - The Story IDs of Sub-tasks attached to the Story Field only applicable when Sub-task feature is enabled
- customFields? StoryCustomField[] - An array of CustomField value assertions for the story
- formattedVcsBranchName? string? - The formatted branch name for this story
- labelIds int[] - An array of label ids attached to the story
- globalId string - The globally unique identifier of the resource
- completed boolean - A true/false boolean indicating if the Story has been completed
- branches? Branch[] - An array of Git branches attached to the story
- labels LabelSlim[] - An array of labels attached to the story
- iterationId int? - The ID of the iteration the story belongs to
- completedAt string? - The time/date the Story was completed
- previousIterationIds int[] - The IDs of the iteration the story belongs to
- externalLinks string[] - An array of external links (strings) associated with a Story
- name string - The name of the story
- startedAt string? - The time/date the Story was started
- commits? Commit[] - An array of commits attached to the story
- files? UploadedFile[] - An array of files attached to the story
- cycleTime? int - The cycle time (in seconds) of this story when complete
- position int - A number representing the position of the story in relation to every other story in the current project
- completedAtOverride string? - A manual override for the time/date the Story was completed
- ownerIds string[] - An array of UUIDs of the owners of this story
- commentIds? int[] - An array of IDs of Comments attached to the story
- mentionIds string[] -
Deprecated:usemember_mention_ids
- blocker boolean - A true/false boolean indicating if the Story is currently a blocker of another story
- linkedFiles? LinkedFile[] - An array of linked files attached to the story
- description? string - The description of the story
- linkedFileIds? int[] - An array of IDs of LinkedFiles attached to the story
- createdAt string - The time/date the Story was created
- groupMentionIds string[] - An array of Group IDs that have been mentioned in the Story description
- externalId string? - 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
- storyType string - The type of story (feature, bug, chore)
- archived boolean - True if the story has been archived or not
- parentStoryId? int? - The ID of the parent story to this story (making this story a sub-task). Field only applicable when Sub-task feature is enabled
- updatedAt string? - The time/date the Story was updated
- blocked boolean - A true/false boolean indicating if the Story is currently blocked
- followerIds string[] - An array of UUIDs for any Members listed as Followers
- leadTime? int - The lead time (in seconds) of this story when complete
- fileIds? int[] - An array of IDs of Files attached to the story
- deadline string? - The due date of the story
- memberMentionIds string[] - An array of Member IDs that have been mentioned in the Story description
- appUrl string - The Shortcut application url for the Story
- comments? StoryComment[] - An array of comments attached to the story
- numTasksCompleted? int - The number of tasks on the story which are complete
- storyLinks TypedStoryLink[] - An array of story links attached to the Story
- started boolean - A true/false boolean indicating if the Story has been started
- taskIds? int[] - An array of IDs of Tasks attached to the story
- syncedItem? SyncedItem - The external application the story is synced with
- movedAt string? - The time/date the Story was last changed workflow-state
- entityType string - A string description of this resource
- startedAtOverride string? - A manual override for the time/date the Story was started
- groupId string? - The ID of the group associated with the story
- epicId int? - The ID of the epic the story belongs to
shortcut: StorySearchResults
The results of the Story search query
Fields
- next string? - The URL path and query string for the next page of search results
- total int - The total number of matches for the search query. The first 1000 matches can be paged through via the API
- data StorySearchResult[] - A list of search results
shortcut: StorySlim
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., comment_ids and file_ids) and it also excludes certain aggregate values (e.g., cycle_time). The description field can be optionally included. Use the Get Story endpoint to fetch the unabridged payload for a Story
Fields
- workflowStateId int - The ID of the workflow state the story is currently in
- workflowId int - The ID of the workflow the story belongs to
- requestedById string - The ID of the Member that requested the story
- storyTemplateId string? - The ID of the story template used to create this story, or null if not created using a template
- projectId int? - The ID of the project the story belongs to
- stats StoryStats - The stats object for Stories
- estimate int? - The numeric point estimate of the story. Can also be null, which means unestimated
- id int - The unique ID of the Story
- subTaskStoryIds? int[] - The Story IDs of Sub-tasks attached to the Story Field only applicable when Sub-task feature is enabled
- customFields? StoryCustomField[] - An array of CustomField value assertions for the story
- formattedVcsBranchName? string? - The formatted branch name for this story
- labelIds int[] - An array of label ids attached to the story
- globalId string - The globally unique identifier of the resource
- completed boolean - A true/false boolean indicating if the Story has been completed
- labels LabelSlim[] - An array of labels attached to the story
- iterationId int? - The ID of the iteration the story belongs to
- completedAt string? - The time/date the Story was completed
- previousIterationIds int[] - The IDs of the iteration the story belongs to
- externalLinks string[] - An array of external links (strings) associated with a Story
- name string - The name of the story
- startedAt string? - The time/date the Story was started
- cycleTime? int - The cycle time (in seconds) of this story when complete
- position int - A number representing the position of the story in relation to every other story in the current project
- completedAtOverride string? - A manual override for the time/date the Story was completed
- ownerIds string[] - An array of UUIDs of the owners of this story
- commentIds int[] - An array of IDs of Comments attached to the story
- mentionIds string[] -
Deprecated:usemember_mention_ids
- blocker boolean - A true/false boolean indicating if the Story is currently a blocker of another story
- description? string - The description of the Story
- linkedFileIds int[] - An array of IDs of LinkedFiles attached to the story
- createdAt string - The time/date the Story was created
- groupMentionIds string[] - An array of Group IDs that have been mentioned in the Story description
- externalId string? - 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
- storyType string - The type of story (feature, bug, chore)
- archived boolean - True if the story has been archived or not
- parentStoryId? int? - The ID of the parent story to this story (making this story a sub-task). Field only applicable when Sub-task feature is enabled
- updatedAt string? - The time/date the Story was updated
- blocked boolean - A true/false boolean indicating if the Story is currently blocked
- followerIds string[] - An array of UUIDs for any Members listed as Followers
- leadTime? int - The lead time (in seconds) of this story when complete
- fileIds int[] - An array of IDs of Files attached to the story
- deadline string? - The due date of the story
- memberMentionIds string[] - An array of Member IDs that have been mentioned in the Story description
- appUrl string - The Shortcut application url for the Story
- numTasksCompleted int - The number of tasks on the story which are complete
- storyLinks TypedStoryLink[] - An array of story links attached to the Story
- started boolean - A true/false boolean indicating if the Story has been started
- taskIds int[] - An array of IDs of Tasks attached to the story
- syncedItem? SyncedItem - The external application the story is synced with
- movedAt string? - The time/date the Story was last changed workflow-state
- entityType string - A string description of this resource
- startedAtOverride string? - A manual override for the time/date the Story was started
- groupId string? - The ID of the group associated with the story
- epicId int? - The ID of the epic the story belongs to
shortcut: StoryStats
The stats object for Stories
Fields
- numRelatedDocuments int - The number of documents related to this Story
shortcut: SyncedItem
The synced item for the story
Fields
- externalId string - The id used to reference an external entity
- url string - The url to the external entity
shortcut: Task
A Task on a Story
Fields
- memberMentionIds string[] - An array of UUIDs of Members mentioned in this Task
- storyId int - The unique identifier of the parent Story
- globalId string - The globally unique identifier of the resource
- description string - Full text of the Task
- createdAt string - The time/date the Task was created
- groupMentionIds string[] - An array of UUIDs of Groups mentioned in this Task
- externalId string? - This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here
- completedAt string? - The time/date the Task was completed
- entityType string - A string description of this resource
- updatedAt string? - The time/date the Task was updated
- id int - The unique ID of the Task
- position int - The number corresponding to the Task's position within a list of Tasks on a Story
- complete boolean - True/false boolean indicating whether the Task has been completed
- ownerIds string[] - An array of UUIDs of the Owners of this Task
- mentionIds string[] -
Deprecated:usemember_mention_ids
shortcut: ThreadedComment
Comments associated with Epic Discussions
Fields
- memberMentionIds string[] - An array of Member IDs that have been mentioned in this Comment
- appUrl string - The Shortcut application url for the Comment
- comments ThreadedComment[] - A nested array of threaded comments
- createdAt string - The time/date the Comment was created
- groupMentionIds string[] - An array of Group IDs that have been mentioned in this Comment
- externalId string? - This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here
- entityType string - A string description of this resource
- deleted boolean - True/false boolean indicating whether the Comment is deleted
- updatedAt string - The time/date the Comment was updated
- id int - The unique ID of the Comment
- text string - The text of the Comment
- authorId string - The unique ID of the Member that authored the Comment
- mentionIds string[] -
Deprecated:usemember_mention_ids
shortcut: TypedStoryLink
The type of Story Link. The string can be subject or object.
Fields
- subjectId int - The ID of the subject Story
- entityType string - A string description of this resource
- updatedAt string - The time/date when the Story Link was last updated
- subjectWorkflowStateId int - The workflow state of the "subject" story
- verb string - How the subject Story acts on the object Story. This can be "blocks", "duplicates", or "relates to"
- createdAt string - The time/date when the Story Link was created
- id int - The unique identifier of the Story Link
- 'type string - This indicates whether the Story is the subject or object in the Story Link
- objectId int - The ID of the object Story
shortcut: UpdateCategory
Fields
- archived? boolean - A true/false boolean indicating if the Category has been archived
- color? string? - The hex color to be displayed with the Category (for example, "#ff0000")
- name? string - The new name of the Category
shortcut: UpdateComment
Fields
- text string - The updated comment text
shortcut: UpdateCustomField
Fields
- values? UpdateCustomFieldEnumValue[] - A collection of EnumValue objects representing the values in the domain of some Custom Field
- name? string - A collection of objects representing reporting periods for years
- description? string - A description of the purpose of this field
- iconSetIdentifier? string - A frontend-controlled string that represents the icon for this custom field
- afterId? string - The ID of the CustomField we want to move this CustomField after
- enabled? boolean - Indicates whether the Field is enabled for the Workspace. Only enabled fields can be applied to Stories
- beforeId? string - The ID of the CustomField we want to move this CustomField before
shortcut: UpdateCustomFieldEnumValue
Fields
- colorKey? "blue"|"purple"|"midnight-blue"|"orange"|"yellow-green"|"brass"|"gray"|"fuchsia"|"yellow"|"pink"|"sky-blue"|"green"|"red"|"black"|"slate"|"turquoise"? - A color key associated with this EnumValue within the CustomField's domain
- id? string - The unique ID of an existing EnumValue within the CustomField's domain
- value? string - A string value within the domain of this Custom Field
- enabled? boolean - Whether this EnumValue is enabled for its CustomField or not. Leaving this key out of the request leaves the current enabled state untouched
shortcut: UpdateDoc
Fields
- contentFormat? "markdown"|"html" - Default content_format: html. Format of content. For input: specifies format of provided content (defaults to 'html'). For output: controls response format - 'markdown' (default) or 'html' to include HTML content. Because output defaults to markdown, set 'markdown' when editing and writing back content you read from GET
- title? string - The new title for the document
- content? string - The new content for the document
shortcut: UpdateEntityTemplate
Request parameters for changing either a template's name or any of the attributes it is designed to pre-populate
Fields
- name? string - The updated template name
- storyContents? UpdateStoryContents - The story contents the template creates
shortcut: UpdateEpic
Fields
- requestedById? string - The ID of the member that requested the epic
- milestoneId? int? -
DeprecatedThe ID of the Milestone this Epic is related to. Useobjective_ids
- description? string - The Epic's description
- externalId? string - This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here
- labels? CreateLabelParams[] - An array of Labels attached to the Epic
- objectiveIds? int[] - An array of IDs for Objectives to which this Epic is related
- archived? boolean - A true/false boolean indicating whether the Epic is in archived state
- startedAtOverride? string? - A manual override for the time/date the Epic was started
- groupId? string? -
DeprecatedThe ID of the group to associate with the epic. Usegroup_ids
- epicStateId? int - The ID of the Epic State
- followerIds? string[] - An array of UUIDs for any Members you want to add as Followers on this Epic
- name? string - The Epic's name
- plannedStartDate? string? - The Epic's planned start date
- groupIds? string[] - An array of UUIDS for Groups to which this Epic is related
- afterId? int - The ID of the Epic we want to move this Epic after
- state? "in progress"|"to do"|"done" -
DeprecatedThe Epic's state (to do, in progress, or done); will be ignored whenepic_state_idis set
- deadline? string? - The Epic's deadline
- completedAtOverride? string? - A manual override for the time/date the Epic was completed
- ownerIds? string[] - An array of UUIDs for any members you want to add as Owners on this Epic
- beforeId? int - The ID of the Epic we want to move this Epic before
shortcut: UpdateFile
Fields
- uploaderId? string - The unique ID assigned to the Member who uploaded the file to Shortcut
- updatedAt? string - The time/date that the file was last updated
- name? string - The name of the file
- description? string - The description of the file
- createdAt? string - The time/date that the file was uploaded
- externalId? string - An additional ID that you may wish to assign to the file
shortcut: UpdateGroup
Fields
- cardAgingMode? "off"|"gradual"|"immediate"? - The card aging mode for stories in this Group: "gradual" (fixed fade steps at 1, 2, and 4 weeks), "immediate", or "off" (explicitly disabled for this Group). Set to null to inherit the Workspace default
- workflowIds? int[] - The Workflow ids to add to the Group
- archived? boolean? - Whether or not this Group is archived
- mentionName? string - The mention name of this Group
- defaultWorkflowId? int? - The ID of the default workflow for stories created in this group
- displayIconId? string? - The Icon id for the avatar of this Group
- color? string? - The color you wish to use for the Group in the system
- colorKey? "blue"|"purple"|"midnight-blue"|"orange"|"yellow-green"|"brass"|"gray"|"fuchsia"|"yellow"|"pink"|"sky-blue"|"green"|"red"|"black"|"slate"|"turquoise" - The color key you wish to use for the Group in the system
- memberIds? string[] - The Member ids to add to this Group
- name? string - The name of this Group
- description? string - The description of this Group
- cardAgingThresholdDays? int? - The number of days an in-progress Story can go without activity before it is considered stale. Required when card_aging_mode is "immediate"; not allowed otherwise
shortcut: UpdateHealth
Fields
- text? string - The description of the Health status
- status? "At Risk"|"On Track"|"Off Track"|"No Health" - The health status of the Epic
shortcut: UpdateIteration
Fields
- endDate? string - The date this Iteration ends, e.g. 2019-07-05
- followerIds? string[] - An array of UUIDs for any Members you want to add as Followers
- groupIds? string[] - An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI
- name? string - The name of this Iteration
- description? string - The description of the Iteration
- labels? CreateLabelParams[] - An array of Labels attached to the Iteration
- startDate? string - The date this Iteration begins, e.g. 2019-07-01
shortcut: UpdateKeyResult
Fields
- observedValue? KeyResultValue -
- targetValue? KeyResultValue -
- name? string - The name of the Key Result
- initialObservedValue? KeyResultValue -
shortcut: UpdateLabel
Fields
- archived? boolean - A true/false boolean indicating if the Label has been archived
- color? string? - The hex color to be displayed with the Label (for example, "#ff0000")
- name? string - The new name of the label
- description? string - The new description of the label
shortcut: UpdateLinkedFile
Fields
- uploaderId? string - The UUID of the member that uploaded the file
- size? int - The filesize, if the integration provided it
- storyId? int - The ID of the linked story
- name? string - The name of the file
- description? string - The description of the file
- thumbnailUrl? string - The URL of the thumbnail, if the integration provided it
- 'type? "google"|"url"|"dropbox"|"box"|"onedrive" - The integration type of the file (e.g. google, dropbox, box)
- url? string - The URL of linked file
shortcut: UpdateMilestone
Fields
- archived? boolean - A boolean indicating whether the Milestone is archived or not
- startedAtOverride? string? - A manual override for the time/date the Milestone was started
- name? string - The name of the Milestone
- description? string - The Milestone's description
- afterId? int - The ID of the Milestone we want to move this Milestone after
- state? "in progress"|"to do"|"done" - The workflow state that the Milestone is in
- categories? CreateCategoryParams[] - An array of IDs of Categories attached to the Milestone
- completedAtOverride? string? - A manual override for the time/date the Milestone was completed
- beforeId? int - The ID of the Milestone we want to move this Milestone before
shortcut: UpdateObjective
Fields
- archived? boolean - A boolean indicating whether the Objective is archived or not
- startedAtOverride? string? - A manual override for the time/date the Objective was started
- name? string - The name of the Objective
- description? string - The Objective's description
- afterId? int - The ID of the Objective we want to move this Objective after
- state? "in progress"|"to do"|"done" - The workflow state that the Objective is in
- categories? CreateCategoryParams[] - An array of IDs of Categories attached to the Objective
- completedAtOverride? string? - A manual override for the time/date the Objective was completed
- beforeId? int - The ID of the Objective we want to move this Objective before
shortcut: UpdateProject
Fields
- daysToThermometer? int - The number of days before the thermometer appears in the Story summary
- archived? boolean - A true/false boolean indicating whether the Story is in archived state
- showThermometer? boolean - Configuration to enable or disable thermometers in the Story summary
- color? string - The color that represents the Project in the UI
- followerIds? string[] - An array of UUIDs for any Members you want to add as Followers
- name? string - The Project's name
- description? string - The Project's description
- teamId? int - The ID of the team the project belongs to
- abbreviation? string - The Project abbreviation used in Story summaries. Should be kept to 3 characters at most
shortcut: UpdateStories
Fields
- workflowStateId? int - The ID of the workflow state to put the stories in
- requestedById? string - The ID of the member that requested the story
- ownerIdsRemove? string[] - The UUIDs of the owners to be removed
- customFieldsAdd? CustomFieldValueParams[] - A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField
- customFieldsRemove? CustomFieldValueParams[] - A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField
- iterationId? int? - The ID of the iteration the story belongs to
- storyType? "feature"|"chore"|"bug" - The type of story (feature, bug, chore)
- archived? boolean - If the Stories should be archived or not
- ownerIdsAdd? string[] - The UUIDs of the new owners to be added
- groupId? string? - The Id of the Group the Stories should belong to
- projectId? int? - The ID of the Project the Stories should belong to
- storyIds int[] - The Ids of the Stories you wish to update
- moveTo? "last"|"first" - One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state
- externalLinks? string[] - An array of External Links associated with this story
- followerIdsRemove? string[] - The UUIDs of the followers to be removed
- estimate? int? - The numeric point estimate of the story. Can also be null, which means unestimated
- labelsRemove? CreateLabelParams[] - An array of labels to be removed
- afterId? int - The ID of the story that the stories are to be moved below
- followerIdsAdd? string[] - The UUIDs of the new followers to be added
- deadline? string? - The due date of the story
- epicId? int? - The ID of the epic the story belongs to
- labelsAdd? CreateLabelParams[] - An array of labels to be added
- beforeId? int - The ID of the story that the stories are to be moved before
shortcut: UpdateStory
Fields
- workflowStateId? int - The ID of the workflow state to put the story in
- requestedById? string - The ID of the member that requested the story
- commitIds? int[] - An array of IDs of Commits attached to the story
- description? string - The description of the story
- linkedFileIds? int[] - An array of IDs of linked files attached to the story
- storyType? "feature"|"chore"|"bug" - The type of story (feature, bug, chore)
- archived? boolean - True if the story is archived, otherwise false
- parentStoryId? int? - The parent story id. If you want to unset this value set parent_story_id to null
- projectId? int? - The ID of the project the story belongs to
- followerIds? string[] - An array of UUIDs of the followers of this story
- fileIds? int[] - An array of IDs of files attached to the story
- estimate? int? - The numeric point estimate of the story. Can also be null, which means unestimated
- afterId? int - The ID of the story we want to move this story after
- deadline? string? - The due date of the story
- pullRequestIds? int[] - An array of IDs of Pull/Merge Requests attached to the story
- customFields? CustomFieldValueParams[] - A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField
- labels? CreateLabelParams[] - An array of labels attached to the story
- iterationId? int? - The ID of the iteration the story belongs to
- startedAtOverride? string? - A manual override for the time/date the Story was started
- groupId? string? - The ID of the group to associate with this story
- moveTo? "last"|"first" - One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state
- externalLinks? string[] - An array of External Links associated with this story
- branchIds? int[] - An array of IDs of Branches attached to the story
- name? string - The title of the story
- subTasks? LinkSubTaskParams[] - An array of story IDs to attach to this story as sub-tasks. This list represents the final state of the parent's sub-tasks - missing stories will be unlinked, new stories will be linked, and the input order reflects sub-task positions
- completedAtOverride? string? - A manual override for the time/date the Story was completed
- ownerIds? string[] - An array of UUIDs of the owners of this story
- epicId? int? - The ID of the epic the story belongs to
- beforeId? int - The ID of the story we want to move this story before
shortcut: UpdateStoryComment
Fields
- text string - The updated comment text
shortcut: UpdateStoryContents
Updated attributes for the template to populate
Fields
- workflowStateId? int? - The ID of the workflow state to be populated
- customFields? CustomFieldValueParams[] - An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField
- description? string - The description of the story
- linkedFileIds? int[] - An array of the linked file IDs to be populated
- labels? CreateLabelParams[] - An array of labels to be populated by the template
- iterationId? int? - The ID of the iteration the to be populated
- storyType? string - The type of story (feature, bug, chore)
- groupId? string? - The ID of the group to be populated
- projectId? int? - The ID of the project the story belongs to
- externalLinks? string[] - An array of external links to be populated
- followerIds? string[] - An array of UUIDs for any Members listed as Followers
- fileIds? int[] - An array of the attached file IDs to be populated
- name? string - The name of the story
- estimate? int? - The numeric point estimate to be populated
- subTasks? CreateSubTaskParams[] - An array of maps specifying the sub-tasks to create and link to the story. Field only applicable when Sub-task feature is enabled
- deadline? string? - The due date of the story
- tasks? BaseTaskParams[] - An array of tasks to be populated by the template
- ownerIds? string[] - An array of UUIDs of the owners of this story
- epicId? int? - The ID of the epic the to be populated
shortcut: UpdateStoryLink
Fields
- subjectId? int - The ID of the subject Story
- verb? "blocks"|"duplicates"|"relates to" - The type of link
- objectId? int - The ID of the object Story
shortcut: UpdateTask
Fields
- description? string - The Task's description
- afterId? int - Move task after this task ID
- complete? boolean - A true/false boolean indicating whether the task is complete
- ownerIds? string[] - An array of UUIDs of the owners of this story
- beforeId? int - Move task before this task ID
shortcut: UploadedFile
An UploadedFile is any document uploaded to your Shortcut Workspace. Files attached from a third-party service are different: see the Linked Files endpoint
Fields
- memberMentionIds string[] - The unique IDs of the Members who are mentioned in the file description
- uploaderId string - The unique ID of the Member who uploaded the file
- description string? - The description of the file
- createdAt string - The time/date that the file was created
- groupMentionIds string[] - The unique IDs of the Groups who are mentioned in the file description
- externalId string? - This field can be set to another unique ID. In the case that the File has been imported from another tool, the ID in the other tool can be indicated here
- thumbnailUrl string? - The url where the thumbnail of the file can be found in Shortcut
- url string? - The URL for the file
- entityType string - A string description of this resource
- filename string - The name assigned to the file in Shortcut upon upload
- size int - The size of the file
- contentType string - Free form string corresponding to a text or image file
- updatedAt string? - The time/date that the file was updated
- storyIds int[] - The unique IDs of the Stories associated with this file
- name string - The optional User-specified name of the file
- id int - The unique ID for the file
- mentionIds string[] -
Deprecated:usemember_mention_ids
shortcut: UploadFilesRequest
Fields
- storyId? int - The story ID that these files will be associated with
- file2? record { fileContent byte[], fileName string } - Optional additional files
- file3? record { fileContent byte[], fileName string } - Optional additional files
- file0 record { fileContent byte[], fileName string } - A file upload. At least one is required
- file1? record { fileContent byte[], fileName string } - Optional additional files
shortcut: Workflow
Workflow is the array of defined Workflow States. Workflow can be queried using the API but must be updated in the Shortcut UI.
Fields
- entityType string - A string description of this resource
- updatedAt string - The date the Workflow was updated
- name string - The name of the workflow
- description string - A description of the workflow
- createdAt string - The date the Workflow was created
- id int - The unique ID of the Workflow
- teamId int - The ID of the team the workflow belongs to
- autoAssignOwner boolean - Indicates if an owner is automatically assigned when an unowned story is started
- projectIds decimal[] - An array of IDs of projects within the Workflow
- defaultStateId int - The unique ID of the default state that new Stories are entered into
- states WorkflowState[] - A map of the states in this Workflow
shortcut: WorkflowState
Workflow State is any of the at least 3 columns. Workflow States correspond to one of 3 types: Unstarted, Started, or Done
Fields
- numStories int - The number of Stories currently in that Workflow State
- color? string - The hex color for this Workflow State
- verb string? - The verb that triggers a move to that Workflow State when making VCS commits
- globalId string - The globally unique identifier of the resource
- description string - The description of what sort of Stories belong in that Workflow state
- createdAt string - The time/date the Workflow State was created
- 'type string - The type of Workflow State (Unstarted, Started, or Finished)
- entityType string - A string description of this resource
- updatedAt string - When the Workflow State was last updated
- name string - The Workflow State's name
- id int - The unique ID of the Workflow State
- position int - The position that the Workflow State is in, starting with 0 at the left
- numStoryTemplates int - The number of Story Templates associated with that Workflow State
Union types
shortcut: HistoryReferences
HistoryReferences
shortcut: CreateStoryFromTemplateParamsSubTasks
CreateStoryFromTemplateParamsSubTasks
shortcut: HistoryActions
HistoryActions
Import
import ballerinax/shortcut;Metadata
Released date: 1 day ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-21 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 44
Current verison: 1
Weekly downloads
Keywords
Vendor/Shortcut
Area/Productivity & Collaboration
Type/Connector
Contributors