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 Documents API

The Documents API from Shortcut Software — 4 operation(s) for documents.

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

This API exposes 8 operations across 4 paths, and defines 11 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.

8 operations 4 paths 11 schemas 2 DELETE3 GET1 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 Documents 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 8

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

Documents 8
GET
/api/v3/documents
List Docs
listDocs → 200400403404422
POST
/api/v3/documents
Create Doc
createDoc body → 201400403404422
GET
/api/v3/documents/{doc-public-id}
Get Doc
getDoc 2 params → 200400403404422
PUT
/api/v3/documents/{doc-public-id}
Update Doc
updateDoc 1 param body → 200400403404422
DELETE
/api/v3/documents/{doc-public-id}
Delete Doc
deleteDoc 1 param body → 204400403404422
GET
/api/v3/documents/{doc-public-id}/epics
List Document Epics
listDocumentEpics 1 param → 200400403404422
PUT
/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
Link Document to Epic
linkDocumentToEpic 2 params → 204400403404422
DELETE
/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
Unlink Document from Epic
unlinkDocumentFromEpic 2 params → 204400403404422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EpicSlim (41 properties), EpicStats (13 properties), LabelSlim (11 properties), Doc (8 properties). Each schema is shown below with its type and property counts.

Doc
object
8 properties 7 required
CreateDoc
object
3 properties 2 required
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
DocSlim
object
3 properties 3 required
DisabledFeatureError
object
2 properties 2 required
UpdateDoc
object
3 properties
UnprocessableError
object
1 property 1 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
GetDoc
object
1 property
EpicStats
object
A group of calculated values for this Epic.
13 properties 13 required
EpicAssociatedGroup
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Shortcut Software publishes across the network.

Shortcut Software Categories API
Shortcut Software Custom Fields API
Shortcut Software Entity Templates API
Shortcut Software Epic Workflow API
Shortcut Software Epics 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 Documents 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.