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

Shortcut Software Epics API

The Epics API from Shortcut Software — 9 operation(s) for epics.

Shortcut Software Epics 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 Epics. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 17 operations across 9 paths, and defines 21 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.

17 operations 9 paths 21 schemas 2 DELETE9 GET4 POST2 PUT

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 Epics 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 17

Across 9 paths, the API surfaces 17 operations — 2 DELETE, 9 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Epics 17
GET
/api/v3/epics
List Epics
listEpics 1 param → 200400404422
POST
/api/v3/epics
Create Epic
createEpic body → 201400404422
GET
/api/v3/epics/paginated
List Epics Paginated
listEpicsPaginated 3 params → 200400404422
GET
/api/v3/epics/{epic-public-id}
Get Epic
getEpic 1 param → 200400404422
PUT
/api/v3/epics/{epic-public-id}
Update Epic
updateEpic 1 param body → 200400404422
DELETE
/api/v3/epics/{epic-public-id}
Delete Epic
deleteEpic 1 param → 204400404422
GET
/api/v3/epics/{epic-public-id}/comments
List Epic Comments
listEpicComments 1 param → 200400404422
POST
/api/v3/epics/{epic-public-id}/comments
Create Epic Comment
createEpicComment 1 param body → 201400404422
POST
/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
Create Epic Comment Comment
createEpicCommentComment 2 params body → 201400404422
GET
/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
Get Epic Comment
getEpicComment 2 params → 200400404422
PUT
/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
Update Epic Comment
updateEpicComment 2 params body → 200400404422
DELETE
/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
Delete Epic Comment
deleteEpicComment 2 params → 204400404422
GET
/api/v3/epics/{epic-public-id}/documents
List Epic Documents
listEpicDocuments 1 param → 200400404422
GET
/api/v3/epics/{epic-public-id}/health
Get Epic Health
getEpicHealth 1 param → 200400404422
POST
/api/v3/epics/{epic-public-id}/health
Create Epic Health
createEpicHealth 1 param body → 201400404422
GET
/api/v3/epics/{epic-public-id}/health-history
List Epic Healths
listEpicHealths 1 param → 200400404422
GET
/api/v3/epics/{epic-public-id}/stories
List Epic Stories
listEpicStories 2 params → 200400404422

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are StorySlim (54 properties), Epic (43 properties), EpicSlim (41 properties), CreateEpic (20 properties). Each schema is shown below with its type and property counts.

EpicSlim
object
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 o…
41 properties 40 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
StorySlim
object
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., commentids an…
54 properties 46 required
Health
object
The current health status of the Epic.
9 properties 3 required
EpicAssociatedGroup
object
2 properties 1 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
CreateEpic
object
20 properties 1 required
DocSlim
object
3 properties 3 required
StoryStats
object
The stats object for Stories
1 property 1 required
UpdateComment
object
1 property 1 required
UpdateEpic
object
20 properties
CreateLabelParams
object
Request parameters for creating a Label on a Shortcut Story.
4 properties 1 required
ThreadedComment
object
Comments associated with Epic Discussions.
13 properties 13 required
CreateCommentComment
object
5 properties 1 required
SyncedItem
object
The synced item for the story.
2 properties 2 required
CreateEpicComment
object
5 properties 1 required
CreateEpicHealth
object
2 properties 1 required
Epic
object
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.
43 properties 42 required
EpicPaginatedResults
object
Results schema for paginated Epic listing.
3 properties 3 required
EpicStats
object
A group of calculated values for this Epic.
13 properties 13 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Shortcut Software publishes across the network.

Shortcut Software Categories API
Shortcut Software Custom Fields API
Shortcut Software Documents API
Shortcut Software Entity Templates API
Shortcut Software Epic Workflow API
Shortcut Software External Link API
Shortcut Software Files API
Shortcut Software Groups API
Shortcut Software Health API
Shortcut Software Integrations API
Shortcut Software Iterations API
Shortcut Software Key Results API
Where this information came from

This is an independent, third-party profile of Shortcut Software Epics 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.