Shortcut

Custom: Fields List

List, browse, or enumerate all Shortcut custom fields and their allowed values. Use this to discover custom field UUIDs and value UUIDs before setting custom fields on stories.

Documents: Create

Create or add a new Shortcut document (doc / page / wiki entry) with Markdown content.

Requiredtitlecontent

Documents: Get By ID

Get, fetch, retrieve, or read a single Shortcut document by its ID. Returns the full Markdown content.

RequireddocId

Documents: List

List, browse, or enumerate all Shortcut documents (docs / pages / wiki entries) in the workspace.

Documents: Search

Search, query, find, or filter Shortcut documents (docs / pages / wiki entries) by title keyword, archived status, or created/followed-by-current-user. Use this for document discovery — NOT for searching stories or epics.

Requiredtitle

Documents: Update

Update, edit, or modify a Shortcut document's title or Markdown content.

RequireddocId

Epics: Create

Create or add a new Shortcut epic (a container for related stories).

Requiredname

Epics: Create Comment

Add, create, or post a comment (or threaded reply) on a Shortcut epic.

RequiredepicPublicIdtext

Epics: Delete

Delete or remove a Shortcut epic permanently. This action cannot be undone.

RequiredepicPublicId

Epics: Get By ID

Get, fetch, retrieve, or look up a single Shortcut epic by its public numeric ID. Returns the full epic record.

RequiredepicPublicId

Epics: Search

Search, query, find, list, or filter Shortcut epics across the workspace. Supports keyword matching on name, description, and comment, plus structured filters: state (specific workflow state name or ID), owner, requester, team, objective, date filters (created/updated/completed/due), and presence checks (hasOwner, hasComment, hasDeadline, hasLabel, isUnstarted, isStarted, isDone, isArchived, isOverdue). Each result includes the epic's workflow state ID (epic_state_id), and the workflow state names are available in relatedEntities.epic_workflows. Pass raw Shortcut search syntax in `query`, structured filters as parameters, or both (they are ANDed). Primary workspace-wide epic search.

Epics: Update

Update, edit, or modify a Shortcut epic's fields (name, description, state, owners, team, deadline, labels, objectives, archived, etc.). Provide only the fields you want to change.

RequiredepicPublicId

Files: Read

Read a file attachment from the Shortcut CDN.

RequiredfileUrl

Iterations: Create

Create a new Shortcut iteration (sprint / cycle) with a name, start date, and end date.

RequirednamestartDateendDate

Iterations: Delete

Delete or remove a Shortcut iteration (sprint / cycle) permanently. This action cannot be undone.

RequirediterationPublicId

Iterations: Get Active

Get, list, or fetch the currently active (in-progress) Shortcut iterations (sprints / cycles) for the current user's teams. Use this to find the current sprint.

Iterations: Get By ID

Get, fetch, retrieve, or look up a single Shortcut iteration (sprint / cycle) by its public numeric ID.

RequirediterationPublicId

Iterations: Get Stories

Get, list, or fetch all stories belonging to a specific Shortcut iteration (sprint / cycle) by iteration ID.

RequirediterationPublicId

Iterations: Get Upcoming

Get, list, or fetch upcoming (not-yet-started, scheduled in the future) Shortcut iterations (sprints / cycles) for the current user's teams.

Iterations: Search

Search, query, find, list, or filter Shortcut iterations (sprints / cycles) across the workspace. Supports keyword matching on name and description, plus filters by state (started/unstarted/done), team, and dates (created, updated, startDate, endDate). Pass raw Shortcut search syntax in `query`, structured filters as parameters, or both (they are ANDed). Primary workspace-wide iteration search.

Iterations: Update

Update, edit, or modify fields on a Shortcut iteration (sprint / cycle) — name, description, start/end dates, teams, followers, labels. Provide only the fields you want to change.

RequirediterationPublicId

Labels: Create

Create or add a new Shortcut label (tag) with an optional color and description.

Requiredname

Labels: Get Stories

Get, list, or find all Shortcut stories tagged with a specific label by label ID.

RequiredlabelPublicId

Labels: List

List, browse, or enumerate all Shortcut labels (tags) defined in the workspace. Optionally include archived labels.

Objectives: Get By ID

Get, fetch, retrieve, or look up a single Shortcut objective (goal / milestone) by its public numeric ID.

RequiredobjectivePublicId

Objectives: Search

Search, query, find, list, or filter Shortcut objectives (goals / milestones) across the workspace. Supports keyword matching on name and description, plus filters by state, owner, requester, team, date filters (created/updated/completed), and presence checks (hasOwner, isUnstarted, isStarted, isDone, isArchived). Pass raw Shortcut search syntax in `query`, structured filters as parameters, or both (they are ANDed). Primary workspace-wide objective search.

Projects: Get By ID

Get, fetch, retrieve, or look up a single Shortcut project by its public numeric ID.

RequiredprojectPublicId

Projects: Get Stories

Get, list, or find all Shortcut stories that belong to a specific project by project ID.

RequiredprojectPublicId

Projects: List

List, browse, or enumerate all Shortcut projects in the workspace. Optionally include archived projects.

Stories: Add External Link

Add or attach an external URL link (e.g. Figma, doc, design spec) to a Shortcut story (ticket / issue).

RequiredstoryPublicIdexternalLink

Stories: Add Relation

Add or link a relationship (e.g. blocks, blocked-by, duplicates, relates-to) between two Shortcut stories (tickets / issues).

RequiredstoryPublicIdrelatedStoryPublicId

Stories: Add Subtask

Link / attach an existing Shortcut story as a sub-task (child) of another story (ticket / issue).

RequiredparentStoryPublicIdsubTaskPublicId

Stories: Add Task

Add a task or checklist item (to-do) to a Shortcut story (ticket / issue).

RequiredstoryPublicIdtaskDescription

Stories: Assign Current User

Self-assign / add the currently authenticated Shortcut user as an owner of a story (ticket / issue).

RequiredstoryPublicId

Stories: Create

Create, add, or file a new Shortcut story (ticket / issue) of type feature, bug, or chore. Requires a name. When no workflow state, workflow, or team default is provided, the story is created in the workspace default workflow.

Requiredname

Stories: Create Comment

Add, create, or post a comment on a Shortcut story (ticket / issue).

RequiredstoryPublicIdtext

Stories: Create Subtask

Create a new Shortcut story as a sub-task (child) of an existing parent story (ticket / issue).

RequiredparentStoryPublicIdname

Stories: Get Branch Name

Generate a valid, conventional git branch name for a Shortcut story (ticket / issue) by its public ID.

RequiredstoryPublicId

Stories: Get By External Link

Find / look up Shortcut stories (tickets / issues) that have a specific external URL (e.g. a doc or design link) attached. Reverse lookup from a URL to its stories — NOT a general story search.

RequiredexternalLink

Stories: Get By ID

Get, fetch, retrieve, or look up a single Shortcut story (ticket / issue) by its public numeric ID. Returns the full story record.

RequiredstoryPublicId

Stories: Get History

Get the change, audit, or activity history for a Shortcut story (ticket / issue) by ID. Returns the timeline of edits, state transitions, and field updates.

RequiredstoryPublicId

Stories: Remove External Link

Remove or detach an external URL link from a Shortcut story (ticket / issue).

RequiredstoryPublicIdexternalLink

Stories: Remove Subtask

Detach / unlink a sub-task from its parent Shortcut story (ticket / issue); the sub-task becomes a regular standalone story.

RequiredsubTaskPublicId

Stories: Search

Search, query, find, list, or filter Shortcut stories (tickets / issues) across the entire workspace. Supports keyword matching on name (title), description (body), and comment, plus structured filters: type (feature/bug/chore), state, owner, requester, team, epic, project, objective, label, priority, severity, estimate, git fields (branch, commit, pr), date filters (created/updated/completed/due), presence checks (hasPr, hasBranch, hasComment, etc.), and is-state flags (isArchived, isDone, isBlocked, etc.). Pass raw Shortcut search syntax in `query`, structured filters as parameters, or both (they are ANDed). This is the primary, workspace-wide story search tool.

Stories: Set External Links

Replace or overwrite the entire list of external URL links on a Shortcut story (ticket / issue).

RequiredstoryPublicIdexternalLinks

Stories: Unassign Current User

Self-unassign / remove the currently authenticated Shortcut user from the owners of a Shortcut story (ticket / issue).

RequiredstoryPublicId

Stories: Update

Update, edit, or modify fields on a Shortcut story (ticket / issue) — name, description, type, state, owners, requester, team, epic, iteration, project, labels, deadline, estimate, custom fields, archived. Provide only the fields you want to change.

RequiredstoryPublicId

Stories: Update Task

Update, edit, complete, or check off a task (checklist item) on a Shortcut story (ticket / issue).

RequiredstoryPublicIdtaskPublicId

Stories: Upload File

Upload a file and attach it to a Shortcut story (ticket / issue).

RequiredstoryPublicIdfilePath

Teams: Get By ID

Get, fetch, retrieve, or look up a single Shortcut team (group) by its UUID. Returns team members, workflows, and metadata.

RequiredteamPublicId

Teams: List

List, browse, or enumerate all Shortcut teams (groups) in the workspace. Use this to discover team IDs, mention names, and default workflows.

Users: Get Current

Get, fetch, or identify the currently authenticated Shortcut user (whoami / me). Returns the user's ID, name, mention name, and email.

Users: Get Current Teams

Get, list, or fetch the Shortcut teams (groups) that the currently authenticated user is a member of.

Users: List

Get, list, browse, or enumerate all Shortcut users (members / people) in the workspace. Use this to look up user UUIDs by name or mention name.

Workflows: Get By ID

Get, fetch, retrieve, or look up a single Shortcut workflow by its ID. Returns the workflow's states (e.g. Backlog, In Development, Completed) and their IDs.

RequiredworkflowPublicId

Workflows: Get Default

Get, fetch, or look up the default Shortcut workflow (and its states) for a specific team, or the workspace-level default workflow when no team is specified.

Workflows: List

List, browse, or enumerate all Shortcut workflows in the workspace, including each workflow's states (Backlog, In Development, Ready for Review, Completed, etc.) and their IDs.