get-iteration
Retrieve a Shortcut iteration by its public ID using the get-iteration tool. Specify whether to return all fields or a slim version to customize the data output.
Instructions
Get a Shortcut iteration by public ID
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| full | No | True to return all iteration fields from the API. False to return a slim version that excludes uncommon fields | |
| iterationPublicId | Yes | The public ID of the iteration to get |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"full": {
"default": false,
"description": "True to return all iteration fields from the API. False to return a slim version that excludes uncommon fields",
"type": "boolean"
},
"iterationPublicId": {
"description": "The public ID of the iteration to get",
"exclusiveMinimum": 0,
"type": "number"
}
},
"required": [
"iterationPublicId"
],
"type": "object"
}