ShortcutClient.jl—API Client for Shortcut's REST API v3

This client has been automatically generated using version 7.10.0 of the openapi-generator. See the generate.sh script for details.

Getting Started

Add ShortcutClient as a dependency to your Julia project:

$ julia --project
julia> ]
pkg> add ShortcutClient

Take the API for a spin:

import OpenAPI.Clients: Client
using ShortcutClient

api_token = ENV["SHORTCUT_API_TOKEN"]
client = Client("https://api.app.shortcut.com", headers=Dict("Shortcut-Token" => api_token))
api = DefaultApi(client)
# Example: Get info about owner of the token used to make API requests.
(member_info, resp) = get_current_member_info(api)
println("Member: $(member_info)")

Rate Limiting

This library does not implement rate limiting. As of this writing, Shortcut warns that its rate limit is 200 requests per minute, after which point HTTP 429 responses will be returned.

Resources

• Shortcut REST API v3
• OpenAPI.jl

API Endpoints

Class	Method
DefaultApi	create_category POST /api/v3/categories Create Category
DefaultApi	create_entity_template POST /api/v3/entity-templates Create Entity Template
DefaultApi	create_epic POST /api/v3/epics Create Epic
DefaultApi	create_epic_comment POST /api/v3/epics/{epic-public-id}/comments Create Epic Comment
DefaultApi	create_epic_comment_comment POST /api/v3/epics/{epic-public-id}/comments/{comment-public-id} Create Epic Comment Comment
DefaultApi	create_group POST /api/v3/groups Create Group
DefaultApi	create_iteration POST /api/v3/iterations Create Iteration
DefaultApi	create_label POST /api/v3/labels Create Label
DefaultApi	create_linked_file POST /api/v3/linked-files Create Linked File
DefaultApi	create_milestone POST /api/v3/milestones Create Milestone
DefaultApi	create_multiple_stories POST /api/v3/stories/bulk Create Multiple Stories
DefaultApi	create_objective POST /api/v3/objectives Create Objective
DefaultApi	create_project POST /api/v3/projects Create Project
DefaultApi	create_story POST /api/v3/stories Create Story
DefaultApi	create_story_comment POST /api/v3/stories/{story-public-id}/comments Create Story Comment
DefaultApi	create_story_from_template POST /api/v3/stories/from-template Create Story From Template
DefaultApi	create_story_link POST /api/v3/story-links Create Story Link
DefaultApi	create_story_reaction POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions Create Story Reaction
DefaultApi	create_task POST /api/v3/stories/{story-public-id}/tasks Create Task
DefaultApi	delete_category DELETE /api/v3/categories/{category-public-id} Delete Category
DefaultApi	delete_custom_field DELETE /api/v3/custom-fields/{custom-field-public-id} Delete Custom Field
DefaultApi	delete_entity_template DELETE /api/v3/entity-templates/{entity-template-public-id} Delete Entity Template
DefaultApi	delete_epic DELETE /api/v3/epics/{epic-public-id} Delete Epic
DefaultApi	delete_epic_comment DELETE /api/v3/epics/{epic-public-id}/comments/{comment-public-id} Delete Epic Comment
DefaultApi	delete_file DELETE /api/v3/files/{file-public-id} Delete File
DefaultApi	delete_iteration DELETE /api/v3/iterations/{iteration-public-id} Delete Iteration
DefaultApi	delete_label DELETE /api/v3/labels/{label-public-id} Delete Label
DefaultApi	delete_linked_file DELETE /api/v3/linked-files/{linked-file-public-id} Delete Linked File
DefaultApi	delete_milestone DELETE /api/v3/milestones/{milestone-public-id} Delete Milestone
DefaultApi	delete_multiple_stories DELETE /api/v3/stories/bulk Delete Multiple Stories
DefaultApi	delete_objective DELETE /api/v3/objectives/{objective-public-id} Delete Objective
DefaultApi	delete_project DELETE /api/v3/projects/{project-public-id} Delete Project
DefaultApi	delete_story DELETE /api/v3/stories/{story-public-id} Delete Story
DefaultApi	delete_story_comment DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id} Delete Story Comment
DefaultApi	delete_story_link DELETE /api/v3/story-links/{story-link-public-id} Delete Story Link
DefaultApi	delete_story_reaction DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions Delete Story Reaction
DefaultApi	delete_task DELETE /api/v3/stories/{story-public-id}/tasks/{task-public-id} Delete Task
DefaultApi	disable_iterations PUT /api/v3/iterations/disable Disable Iterations
DefaultApi	disable_story_templates PUT /api/v3/entity-templates/disable Disable Story Templates
DefaultApi	enable_iterations PUT /api/v3/iterations/enable Enable Iterations
DefaultApi	enable_story_templates PUT /api/v3/entity-templates/enable Enable Story Templates
DefaultApi	get_category GET /api/v3/categories/{category-public-id} Get Category
DefaultApi	get_current_member_info GET /api/v3/member Get Current Member Info
DefaultApi	get_custom_field GET /api/v3/custom-fields/{custom-field-public-id} Get Custom Field
DefaultApi	get_entity_template GET /api/v3/entity-templates/{entity-template-public-id} Get Entity Template
DefaultApi	get_epic GET /api/v3/epics/{epic-public-id} Get Epic
DefaultApi	get_epic_comment GET /api/v3/epics/{epic-public-id}/comments/{comment-public-id} Get Epic Comment
DefaultApi	get_epic_workflow GET /api/v3/epic-workflow Get Epic Workflow
DefaultApi	get_external_link_stories GET /api/v3/external-link/stories Get External Link Stories
DefaultApi	get_file GET /api/v3/files/{file-public-id} Get File
DefaultApi	get_group GET /api/v3/groups/{group-public-id} Get Group
DefaultApi	get_iteration GET /api/v3/iterations/{iteration-public-id} Get Iteration
DefaultApi	get_key_result GET /api/v3/key-results/{key-result-public-id} Get Key Result
DefaultApi	get_label GET /api/v3/labels/{label-public-id} Get Label
DefaultApi	get_linked_file GET /api/v3/linked-files/{linked-file-public-id} Get Linked File
DefaultApi	get_member GET /api/v3/members/{member-public-id} Get Member
DefaultApi	get_milestone GET /api/v3/milestones/{milestone-public-id} Get Milestone
DefaultApi	get_objective GET /api/v3/objectives/{objective-public-id} Get Objective
DefaultApi	get_project GET /api/v3/projects/{project-public-id} Get Project
DefaultApi	get_repository GET /api/v3/repositories/{repo-public-id} Get Repository
DefaultApi	get_story GET /api/v3/stories/{story-public-id} Get Story
DefaultApi	get_story_comment GET /api/v3/stories/{story-public-id}/comments/{comment-public-id} Get Story Comment
DefaultApi	get_story_link GET /api/v3/story-links/{story-link-public-id} Get Story Link
DefaultApi	get_task GET /api/v3/stories/{story-public-id}/tasks/{task-public-id} Get Task
DefaultApi	get_workflow GET /api/v3/workflows/{workflow-public-id} Get Workflow
DefaultApi	list_categories GET /api/v3/categories List Categories
DefaultApi	list_category_milestones GET /api/v3/categories/{category-public-id}/milestones List Category Milestones
DefaultApi	list_category_objectives GET /api/v3/categories/{category-public-id}/objectives List Category Objectives
DefaultApi	list_custom_fields GET /api/v3/custom-fields List Custom Fields
DefaultApi	list_entity_templates GET /api/v3/entity-templates List Entity Templates
DefaultApi	list_epic_comments GET /api/v3/epics/{epic-public-id}/comments List Epic Comments
DefaultApi	list_epic_stories GET /api/v3/epics/{epic-public-id}/stories List Epic Stories
DefaultApi	list_epics GET /api/v3/epics List Epics
DefaultApi	list_files GET /api/v3/files List Files
DefaultApi	list_group_stories GET /api/v3/groups/{group-public-id}/stories List Group Stories
DefaultApi	list_groups GET /api/v3/groups List Groups
DefaultApi	list_iteration_stories GET /api/v3/iterations/{iteration-public-id}/stories List Iteration Stories
DefaultApi	list_iterations GET /api/v3/iterations List Iterations
DefaultApi	list_label_epics GET /api/v3/labels/{label-public-id}/epics List Label Epics
DefaultApi	list_label_stories GET /api/v3/labels/{label-public-id}/stories List Label Stories
DefaultApi	list_labels GET /api/v3/labels List Labels
DefaultApi	list_linked_files GET /api/v3/linked-files List Linked Files
DefaultApi	list_members GET /api/v3/members List Members
DefaultApi	list_milestone_epics GET /api/v3/milestones/{milestone-public-id}/epics List Milestone Epics
DefaultApi	list_milestones GET /api/v3/milestones List Milestones
DefaultApi	list_objective_epics GET /api/v3/objectives/{objective-public-id}/epics List Objective Epics
DefaultApi	list_objectives GET /api/v3/objectives List Objectives
DefaultApi	list_projects GET /api/v3/projects List Projects
DefaultApi	list_repositories GET /api/v3/repositories List Repositories
DefaultApi	list_stories GET /api/v3/projects/{project-public-id}/stories List Stories
DefaultApi	list_story_comment GET /api/v3/stories/{story-public-id}/comments List Story Comment
DefaultApi	list_workflows GET /api/v3/workflows List Workflows
DefaultApi	search GET /api/v3/search Search
DefaultApi	search_epics GET /api/v3/search/epics Search Epics
DefaultApi	search_iterations GET /api/v3/search/iterations Search Iterations
DefaultApi	search_milestones GET /api/v3/search/milestones Search Milestones
DefaultApi	search_objectives GET /api/v3/search/objectives Search Objectives
DefaultApi	search_stories GET /api/v3/search/stories Search Stories
DefaultApi	search_stories_old POST /api/v3/stories/search Search Stories (Old)
DefaultApi	story_history GET /api/v3/stories/{story-public-id}/history Story History
DefaultApi	unlink_comment_thread_from_slack POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack Unlink Comment thread from Slack
DefaultApi	unlink_productboard_from_epic POST /api/v3/epics/{epic-public-id}/unlink-productboard Unlink Productboard from Epic
DefaultApi	update_category PUT /api/v3/categories/{category-public-id} Update Category
DefaultApi	update_custom_field PUT /api/v3/custom-fields/{custom-field-public-id} Update Custom Field
DefaultApi	update_entity_template PUT /api/v3/entity-templates/{entity-template-public-id} Update Entity Template
DefaultApi	update_epic PUT /api/v3/epics/{epic-public-id} Update Epic
DefaultApi	update_epic_comment PUT /api/v3/epics/{epic-public-id}/comments/{comment-public-id} Update Epic Comment
DefaultApi	update_file PUT /api/v3/files/{file-public-id} Update File
DefaultApi	update_group PUT /api/v3/groups/{group-public-id} Update Group
DefaultApi	update_iteration PUT /api/v3/iterations/{iteration-public-id} Update Iteration
DefaultApi	update_key_result PUT /api/v3/key-results/{key-result-public-id} Update Key Result
DefaultApi	update_label PUT /api/v3/labels/{label-public-id} Update Label
DefaultApi	update_linked_file PUT /api/v3/linked-files/{linked-file-public-id} Update Linked File
DefaultApi	update_milestone PUT /api/v3/milestones/{milestone-public-id} Update Milestone
DefaultApi	update_multiple_stories PUT /api/v3/stories/bulk Update Multiple Stories
DefaultApi	update_objective PUT /api/v3/objectives/{objective-public-id} Update Objective
DefaultApi	update_project PUT /api/v3/projects/{project-public-id} Update Project
DefaultApi	update_story PUT /api/v3/stories/{story-public-id} Update Story
DefaultApi	update_story_comment PUT /api/v3/stories/{story-public-id}/comments/{comment-public-id} Update Story Comment
DefaultApi	update_story_link PUT /api/v3/story-links/{story-link-public-id} Update Story Link
DefaultApi	update_task PUT /api/v3/stories/{story-public-id}/tasks/{task-public-id} Update Task
DefaultApi	upload_files POST /api/v3/files Upload Files

Models

• BaseTaskParams
• BasicWorkspaceInfo
• Branch
• Category
• Commit
• CreateCategory
• CreateCategoryParams
• CreateCommentComment
• CreateEntityTemplate
• CreateEpic
• CreateEpicComment
• CreateGroup
• CreateIteration
• CreateLabelParams
• CreateLinkedFile
• CreateMilestone
• CreateObjective
• CreateOrDeleteStoryReaction
• CreateProject
• CreateStories
• CreateStoryComment
• CreateStoryCommentParams
• CreateStoryContents
• CreateStoryFromTemplateParams
• CreateStoryLink
• CreateStoryLinkParams
• CreateStoryParams
• CreateSubTaskParams
• CreateTask
• CreateTaskParams
• CustomField
• CustomFieldEnumValue
• CustomFieldValueParams
• DataConflictError
• DeleteStories
• EntityTemplate
• Epic
• EpicAssociatedGroup
• EpicSearchResult
• EpicSearchResults
• EpicSlim
• EpicState
• EpicStats
• EpicWorkflow
• Group
• History
• HistoryActionBranchCreate
• HistoryActionBranchMerge
• HistoryActionBranchPush
• HistoryActionLabelCreate
• HistoryActionLabelDelete
• HistoryActionLabelUpdate
• HistoryActionProjectUpdate
• HistoryActionPullRequest
• HistoryActionStoryCommentCreate
• HistoryActionStoryCreate
• HistoryActionStoryDelete
• HistoryActionStoryLinkCreate
• HistoryActionStoryLinkDelete
• HistoryActionStoryLinkUpdate
• HistoryActionStoryUpdate
• HistoryActionTaskCreate
• HistoryActionTaskDelete
• HistoryActionTaskUpdate
• HistoryActionWorkspace2BulkUpdate
• HistoryChangesStory
• HistoryChangesStoryLink
• HistoryChangesTask
• HistoryReferenceBranch
• HistoryReferenceCommit
• HistoryReferenceCustomFieldEnumValue
• HistoryReferenceEpic
• HistoryReferenceGeneral
• HistoryReferenceGroup
• HistoryReferenceIteration
• HistoryReferenceLabel
• HistoryReferenceProject
• HistoryReferenceStory
• HistoryReferenceStoryTask
• HistoryReferenceWorkflowState
• Icon
• Identity
• Iteration
• IterationAssociatedGroup
• IterationSearchResults
• IterationSlim
• IterationStats
• KeyResult
• KeyResultValue
• Label
• LabelSlim
• LabelStats
• LinkedFile
• MaxSearchResultsExceededError
• Member
• MemberInfo
• Milestone
• MilestoneStats
• Objective
• ObjectiveSearchResult
• ObjectiveSearchResults
• ObjectiveStats
• Profile
• Project
• ProjectStats
• PullRequest
• PullRequestLabel
• RemoveCustomFieldParams
• RemoveLabelParams
• Repository
• SearchResults
• SearchStories
• Story
• StoryComment
• StoryContents
• StoryContentsTask
• StoryCustomField
• StoryHistoryChangeAddsRemovesInt
• StoryHistoryChangeAddsRemovesUuid
• StoryHistoryChangeOldNewBool
• StoryHistoryChangeOldNewInt
• StoryHistoryChangeOldNewStr
• StoryHistoryChangeOldNewUuid
• StoryLink
• StoryReaction
• StorySearchResult
• StorySearchResults
• StorySlim
• StoryStats
• SyncedItem
• Task
• ThreadedComment
• TypedStoryLink
• UnusableEntitlementError
• UpdateCategory
• UpdateComment
• UpdateCustomField
• UpdateCustomFieldEnumValue
• UpdateEntityTemplate
• UpdateEpic
• UpdateFile
• UpdateGroup
• UpdateIteration
• UpdateKeyResult
• UpdateLabel
• UpdateLinkedFile
• UpdateMilestone
• UpdateObjective
• UpdateProject
• UpdateStories
• UpdateStory
• UpdateStoryComment
• UpdateStoryContents
• UpdateStoryLink
• UpdateTask
• UploadedFile
• Workflow
• WorkflowState

License

Copyright 2024–2025 Daniel Gregoire

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.