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

The Objectives API from Shortcut Software — 5 operation(s) for objectives.

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

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

9 operations 5 paths 13 schemas 1 DELETE5 GET2 POST1 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 Objectives 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 9

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

Objectives 9
GET
/api/v3/objectives
List Objectives
listObjectives → 200400404422
POST
/api/v3/objectives
Create Objective
createObjective body → 201400403404422
GET
/api/v3/objectives/{objective-public-id}
Get Objective
getObjective 1 param → 200400404422
PUT
/api/v3/objectives/{objective-public-id}
Update Objective
updateObjective 1 param body → 200400404422
DELETE
/api/v3/objectives/{objective-public-id}
Delete Objective
deleteObjective 1 param → 204400404422
GET
/api/v3/objectives/{objective-public-id}/epics
List Objective Epics
listObjectiveEpics 1 param → 200400404422
GET
/api/v3/objectives/{objective-public-id}/health
Get Objective Health
getObjectiveHealth 1 param → 200400404422
POST
/api/v3/objectives/{objective-public-id}/health
Create Objective Health
createObjectiveHealth 1 param body → 201400404422
GET
/api/v3/objectives/{objective-public-id}/health-history
List Objective Healths
listObjectiveHealths 1 param → 200400404422

Schemas 13

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

Objective
object
An Objective is a collection of Epics that represent a release or some other large initiative that you are working on.
20 properties 20 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
UpdateObjective
object
9 properties
Category
object
A Category can be used to associate Objectives.
10 properties 10 required
UnusableEntitlementError
object
3 properties 3 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
Health
object
The current health status of the Epic.
9 properties 3 required
ObjectiveStats
object
A group of calculated values for this Objective.
3 properties 1 required
CreateCategoryParams
object
Request parameters for creating a Category with a Objective.
3 properties 1 required
EpicStats
object
A group of calculated values for this Epic.
13 properties 13 required
EpicAssociatedGroup
object
2 properties 1 required
CreateObjective
object
6 properties 1 required
CreateObjectiveHealth
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shortcut-software-objectives-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 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
Where this information came from

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