How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Shortcut Software

Shortcut Software Search API

The Search API from Shortcut Software — 7 operation(s) for search.

Documentation Provider Profile APIs.io OpenAPI GitHub

Shortcut Software Search API is one of 25 APIs that Shortcut Software publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Search. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 7 paths, and defines 38 schemas. It is described by OpenAPI 3.2.0, at version 3.0.

Requests are made against a single base URL, https://api.app.shortcut.com.

7 operations 7 paths 38 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0
Base URL
https://api.app.shortcut.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Shortcut Software Search API declares 1 security scheme for authenticating requests. An API key is passed in the header as Shortcut-Token (api_token). By default, every request must be authenticated.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Search 7
GET
/api/v3/search
Search
search 5 params → 200400404422
GET
/api/v3/search/documents
Search Documents
searchDocuments 6 params → 200400403404422
GET
/api/v3/search/epics
Search Epics
searchEpics 5 params → 200400404422
GET
/api/v3/search/iterations
Search Iterations
searchIterations 5 params → 200400404422
GET
/api/v3/search/milestones
Search Milestones
searchMilestones 5 params → 200400404422
GET
/api/v3/search/objectives
Search Objectives
searchObjectives 5 params → 200400404422
GET
/api/v3/search/stories
Search Stories
searchStories 5 params → 200400404422

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are StorySearchResult (61 properties), EpicSearchResult (43 properties), PullRequest (24 properties), ObjectiveSearchResult (20 properties). Each schema is shown below with its type and property counts.

Branch
object
Branch refers to a VCS branch. Branches are feature branches associated with Shortcut Stories.
11 properties 11 required
StoryReaction
object
Emoji reaction on a comment.
2 properties 2 required
LabelSlim
object
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 u…
11 properties 11 required
EpicSearchResults
object
The results of the Epic search query.
3 properties 3 required
Health
object
The current health status of the Epic.
9 properties 3 required
StorySearchResults
object
The results of the Story search query.
3 properties 3 required
EpicAssociatedGroup
object
2 properties 1 required
IterationSlim
object
IterationSlim represents the same resource as an Iteration, but is more light-weight. Use the [Get Iteration](Get-Iteration) endpoint to fetch the unabridged p…
19 properties 19 required
Identity
object
The Identity of the VCS user that authored the Commit.
3 properties 3 required
StoryCustomField
object
3 properties 3 required
TypedStoryLink
object
The type of Story Link. The string can be subject or object.
9 properties 9 required
LabelStats
object
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.
17 properties 17 required
StoryStats
object
The stats object for Stories
1 property 1 required
DocSlim
object
3 properties 3 required
Commit
object
Commit refers to a VCS commit and all associated details.
12 properties 12 required
Category
object
A Category can be used to associate Objectives.
10 properties 10 required
EpicSearchResult
object
An Epic in search results. This is typed differently from Epic because the details=slim search argument will omit some fields.
43 properties 40 required
PullRequestLabel
object
Corresponds to a VCS Label associated with a Pull Request.
5 properties 4 required
MaxSearchResultsExceededError
object
Error returned when total maximum supported results have been reached.
3 properties 3 required
ThreadedComment
object
Comments associated with Epic Discussions.
13 properties 13 required
Task
object
A Task on a Story.
15 properties 15 required
DisabledFeatureError
object
2 properties 2 required
SearchResults
object
The results of the multi-entity search query.
4 properties
MilestoneStats
object
A group of calculated values for this Milestone.
3 properties 1 required
DocSearchResults
object
The results of the Document search query.
3 properties 3 required
UploadedFile
object
An UploadedFile is any document uploaded to your Shortcut Workspace. Files attached from a third-party service are different: see the Linked Files endpoint.
17 properties 17 required
IterationStats
object
A group of calculated values for this Iteration.
13 properties 11 required
Label
object
A Label can be used to associate and filter Stories and Epics, and also create new Workspaces.
12 properties 11 required
SyncedItem
object
The synced item for the story.
2 properties 2 required
ObjectiveSearchResults
object
The results of the Objective search query.
3 properties 3 required
PullRequest
object
Corresponds to a VCS Pull Request attached to a Shortcut story.
24 properties 20 required
ObjectiveSearchResult
object
A Milestone in search results. This is typed differently from Milestone because the details=slim search argument will omit some fields.
20 properties 19 required
StorySearchResult
object
A Story in search results. This is typed differently from Story because the details=slim search argument will omit some fields.
61 properties 41 required
IterationSearchResults
object
The results of the Iteration search query.
3 properties 3 required
EpicStats
object
A group of calculated values for this Epic.
13 properties 13 required
IterationAssociatedGroup
object
2 properties 1 required
StoryComment
object
A Comment is any note added within the Comment field of a Story.
19 properties 16 required
LinkedFile
object
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,…
16 properties 16 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shortcut-software-search-api-openapi.yml Raw ↑

Other APIs Shortcut Software publishes across the network.

Shortcut Software Categories API
AE Profile APIs.io
Shortcut Software Custom Fields API
AE Profile APIs.io
Shortcut Software Documents API
AE Profile APIs.io
Shortcut Software Entity Templates API
AE Profile APIs.io
Shortcut Software Epic Workflow API
AE Profile APIs.io
Shortcut Software Epics API
AE Profile APIs.io
Shortcut Software External Link API
AE Profile APIs.io
Shortcut Software Files API
AE Profile APIs.io
Shortcut Software Groups API
AE Profile APIs.io
Shortcut Software Health API
AE Profile APIs.io
Shortcut Software Integrations API
AE Profile APIs.io
Shortcut Software Iterations API
AE Profile APIs.io
#Search
← Back to S APIs
API Details
ID
shortcut-software:shortcut-software-search-api
Base URL
https://api.app.shortcut.com
Docs
https://developer.shortcut.com/api/rest/v3
Provider
Shortcut Software
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=shortcut-software-search-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/shortcut-software-search-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Shortcut Software Search API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.