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

The Iterations API from Shortcut Software — 5 operation(s) for iterations.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 8 operations across 5 paths, and defines 15 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 5 paths 15 schemas 1 DELETE3 GET1 POST3 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 Iterations 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 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Iterations 8
GET
/api/v3/iterations
List Iterations
listIterations → 200400404422
POST
/api/v3/iterations
Create Iteration
createIteration body → 201400404422
PUT
/api/v3/iterations/disable
Disable Iterations
disableIterations → 204400404422
PUT
/api/v3/iterations/enable
Enable Iterations
enableIterations → 204400404422
GET
/api/v3/iterations/{iteration-public-id}
Get Iteration
getIteration 1 param → 200400404422
PUT
/api/v3/iterations/{iteration-public-id}
Update Iteration
updateIteration 1 param body → 200400404422
DELETE
/api/v3/iterations/{iteration-public-id}
Delete Iteration
deleteIteration 1 param → 204400404422
GET
/api/v3/iterations/{iteration-public-id}/stories
List Iteration Stories
listIterationStories 2 params → 200400404422

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are StorySlim (54 properties), Iteration (20 properties), IterationSlim (19 properties), LabelStats (17 properties). Each schema is shown below with its type and property counts.

Label
object
A Label can be used to associate and filter Stories and Epics, and also create new Workspaces.
12 properties 11 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
SyncedItem
object
The synced item for the story.
2 properties 2 required
Iteration
object
An Iteration is a defined, time-boxed period of development for a collection of Stories. See https://help.shortcut.com/hc/en-us/articles/360028953452-Iteration…
20 properties 20 required
CreateIteration
object
7 properties 3 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
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
UpdateIteration
object
7 properties
IterationAssociatedGroup
object
2 properties 1 required
CreateLabelParams
object
Request parameters for creating a Label on a Shortcut Story.
4 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
StoryCustomField
object
3 properties 3 required
TypedStoryLink
object
The type of Story Link. The string can be subject or object.
9 properties 9 required
IterationStats
object
A group of calculated values for this Iteration.
13 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shortcut-software-iterations-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 Key Results API
AE Profile APIs.io
#Iterations
← Back to S APIs
API Details
ID
shortcut-software:shortcut-software-iterations-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-iterations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/shortcut-software-iterations-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 Iterations 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.