Can I use Shortcut as a CLI?

Yes. KosmoKrator exposes a Shortcut CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Shortcut through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Shortcut tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Shortcut credentials stored?

Shortcut credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Shortcut MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

productivity

Shortcut Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Shortcut KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.shortcut.*. Use lua_read_doc("integrations.shortcut") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Shortcut workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.shortcut.list_categories({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("shortcut"))' --json
kosmo integrations:lua --eval 'print(docs.read("shortcut.list_categories"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local shortcut = app.integrations.shortcut
local result = shortcut.list_categories({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.shortcut, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.shortcut.default.* or app.integrations.shortcut.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Shortcut, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Shortcut Integration

Namespace: shortcut

This integration exposes Shortcut REST API v3 operations as endpoint-specific tools. It was generated from the official Swagger file at https://developer.shortcut.com/api/rest/v3/shortcut.swagger.json and uses the documented Shortcut-Token header authentication against https://api.app.shortcut.com.

Use list/search endpoints first to discover public IDs, then pass those IDs to get, update, delete, or link operations. Path placeholders from the API such as story-public-id are exposed as snake_case tool parameters such as story_public_id. JSON request bodies are passed through the body object. The file upload endpoint uses multipart fields and expects local file paths for file0, file1, file2, and file3.

Coverage

Official paths: 86
Official operations: 144
Read operations: 71
Write operations: 73

Examples

local stories = shortcut.shortcut_search_stories({
  body = { query = "state:unstarted owner:me" }
})

local story = shortcut.shortcut_get_story({ story_public_id = 123 })

local created = shortcut.shortcut_create_story({
  body = { name = "Draft integration docs", workflow_state_id = 500000001 }
})

Common Tools

shortcut_list_categories - GET /api/v3/categories
shortcut_create_category - POST /api/v3/categories
shortcut_get_category - GET /api/v3/categories/{category-public-id}
shortcut_update_category - PUT /api/v3/categories/{category-public-id}
shortcut_delete_category - DELETE /api/v3/categories/{category-public-id}
shortcut_list_category_milestones - GET /api/v3/categories/{category-public-id}/milestones
shortcut_list_category_objectives - GET /api/v3/categories/{category-public-id}/objectives
shortcut_list_custom_fields - GET /api/v3/custom-fields
shortcut_get_custom_field - GET /api/v3/custom-fields/{custom-field-public-id}
shortcut_update_custom_field - PUT /api/v3/custom-fields/{custom-field-public-id}
shortcut_delete_custom_field - DELETE /api/v3/custom-fields/{custom-field-public-id}
shortcut_list_docs - GET /api/v3/documents
shortcut_create_doc - POST /api/v3/documents
shortcut_get_doc - GET /api/v3/documents/{doc-public-id}
shortcut_update_doc - PUT /api/v3/documents/{doc-public-id}
shortcut_delete_doc - DELETE /api/v3/documents/{doc-public-id}
shortcut_list_document_epics - GET /api/v3/documents/{doc-public-id}/epics
shortcut_link_document_to_epic - PUT /api/v3/documents/{doc-public-id}/epics/{epic-public-id}
shortcut_unlink_document_from_epic - DELETE /api/v3/documents/{doc-public-id}/epics/{epic-public-id}
shortcut_load_tiptap_document_json - GET /api/v3/documents/{doc-public-id}/tiptap-load
shortcut_list_entity_templates - GET /api/v3/entity-templates
shortcut_create_entity_template - POST /api/v3/entity-templates
shortcut_disable_story_templates - PUT /api/v3/entity-templates/disable
shortcut_enable_story_templates - PUT /api/v3/entity-templates/enable
shortcut_get_entity_template - GET /api/v3/entity-templates/{entity-template-public-id}
shortcut_update_entity_template - PUT /api/v3/entity-templates/{entity-template-public-id}
shortcut_delete_entity_template - DELETE /api/v3/entity-templates/{entity-template-public-id}
shortcut_get_epic_workflow - GET /api/v3/epic-workflow
shortcut_list_epics - GET /api/v3/epics
shortcut_create_epic - POST /api/v3/epics

All examples use fake IDs and safe placeholder values. Real API tokens should be configured through the host credential resolver, not hard-coded in Lua.

Raw agent markdown

# Shortcut Integration

Namespace: `shortcut`

This integration exposes Shortcut REST API v3 operations as endpoint-specific tools. It was generated from the official Swagger file at `https://developer.shortcut.com/api/rest/v3/shortcut.swagger.json` and uses the documented `Shortcut-Token` header authentication against `https://api.app.shortcut.com`.

Use list/search endpoints first to discover public IDs, then pass those IDs to get, update, delete, or link operations. Path placeholders from the API such as `story-public-id` are exposed as snake_case tool parameters such as `story_public_id`. JSON request bodies are passed through the `body` object. The file upload endpoint uses multipart fields and expects local file paths for `file0`, `file1`, `file2`, and `file3`.

## Coverage

- Official paths: 86
- Official operations: 144
- Read operations: 71
- Write operations: 73

## Examples

```lua
local stories = shortcut.shortcut_search_stories({
  body = { query = "state:unstarted owner:me" }
})

local story = shortcut.shortcut_get_story({ story_public_id = 123 })

local created = shortcut.shortcut_create_story({
  body = { name = "Draft integration docs", workflow_state_id = 500000001 }
})
```

## Common Tools

- `shortcut_list_categories` - GET /api/v3/categories
- `shortcut_create_category` - POST /api/v3/categories
- `shortcut_get_category` - GET /api/v3/categories/{category-public-id}
- `shortcut_update_category` - PUT /api/v3/categories/{category-public-id}
- `shortcut_delete_category` - DELETE /api/v3/categories/{category-public-id}
- `shortcut_list_category_milestones` - GET /api/v3/categories/{category-public-id}/milestones
- `shortcut_list_category_objectives` - GET /api/v3/categories/{category-public-id}/objectives
- `shortcut_list_custom_fields` - GET /api/v3/custom-fields
- `shortcut_get_custom_field` - GET /api/v3/custom-fields/{custom-field-public-id}
- `shortcut_update_custom_field` - PUT /api/v3/custom-fields/{custom-field-public-id}
- `shortcut_delete_custom_field` - DELETE /api/v3/custom-fields/{custom-field-public-id}
- `shortcut_list_docs` - GET /api/v3/documents
- `shortcut_create_doc` - POST /api/v3/documents
- `shortcut_get_doc` - GET /api/v3/documents/{doc-public-id}
- `shortcut_update_doc` - PUT /api/v3/documents/{doc-public-id}
- `shortcut_delete_doc` - DELETE /api/v3/documents/{doc-public-id}
- `shortcut_list_document_epics` - GET /api/v3/documents/{doc-public-id}/epics
- `shortcut_link_document_to_epic` - PUT /api/v3/documents/{doc-public-id}/epics/{epic-public-id}
- `shortcut_unlink_document_from_epic` - DELETE /api/v3/documents/{doc-public-id}/epics/{epic-public-id}
- `shortcut_load_tiptap_document_json` - GET /api/v3/documents/{doc-public-id}/tiptap-load
- `shortcut_list_entity_templates` - GET /api/v3/entity-templates
- `shortcut_create_entity_template` - POST /api/v3/entity-templates
- `shortcut_disable_story_templates` - PUT /api/v3/entity-templates/disable
- `shortcut_enable_story_templates` - PUT /api/v3/entity-templates/enable
- `shortcut_get_entity_template` - GET /api/v3/entity-templates/{entity-template-public-id}
- `shortcut_update_entity_template` - PUT /api/v3/entity-templates/{entity-template-public-id}
- `shortcut_delete_entity_template` - DELETE /api/v3/entity-templates/{entity-template-public-id}
- `shortcut_get_epic_workflow` - GET /api/v3/epic-workflow
- `shortcut_list_epics` - GET /api/v3/epics
- `shortcut_create_epic` - POST /api/v3/epics

All examples use fake IDs and safe placeholder values. Real API tokens should be configured through the host credential resolver, not hard-coded in Lua.

Metadata-derived Lua example

local result = app.integrations.shortcut.list_categories({})
print(result)

Functions

list_categories Read

List Categories Official Shortcut endpoint: GET /api/v3/categories.

Lua path: app.integrations.shortcut.list_categories
Full name: shortcut.shortcut_list_categories

Parameter	Type	Required	Description
No parameters.

create_category Write

Create Category Official Shortcut endpoint: POST /api/v3/categories.

Lua path: app.integrations.shortcut.create_category
Full name: shortcut.shortcut_create_category

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

get_category Read

Get Category Official Shortcut endpoint: GET /api/v3/categories/{category-public-id}.

Lua path: app.integrations.shortcut.get_category
Full name: shortcut.shortcut_get_category

Parameter	Type	Required	Description
`category_public_id`	integer	yes	The unique ID of the Category.

update_category Write

Update Category Official Shortcut endpoint: PUT /api/v3/categories/{category-public-id}.

Lua path: app.integrations.shortcut.update_category
Full name: shortcut.shortcut_update_category

Parameter	Type	Required	Description
`category_public_id`	integer	yes	The unique ID of the Category you wish to update.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_category Write

Delete Category Official Shortcut endpoint: DELETE /api/v3/categories/{category-public-id}.

Lua path: app.integrations.shortcut.delete_category
Full name: shortcut.shortcut_delete_category

Parameter	Type	Required	Description
`category_public_id`	integer	yes	The unique ID of the Category.

list_category_milestones Read

List Category Milestones Official Shortcut endpoint: GET /api/v3/categories/{category-public-id}/milestones.

Lua path: app.integrations.shortcut.list_category_milestones
Full name: shortcut.shortcut_list_category_milestones

Parameter	Type	Required	Description
`category_public_id`	integer	yes	The unique ID of the Category.

list_category_objectives Read

List Category Objectives Official Shortcut endpoint: GET /api/v3/categories/{category-public-id}/objectives.

Lua path: app.integrations.shortcut.list_category_objectives
Full name: shortcut.shortcut_list_category_objectives

Parameter	Type	Required	Description
`category_public_id`	integer	yes	The unique ID of the Category.

list_custom_fields Read

List Custom Fields Official Shortcut endpoint: GET /api/v3/custom-fields.

Lua path: app.integrations.shortcut.list_custom_fields
Full name: shortcut.shortcut_list_custom_fields

Parameter	Type	Required	Description
No parameters.

get_custom_field Read

Get Custom Field Official Shortcut endpoint: GET /api/v3/custom-fields/{custom-field-public-id}.

Lua path: app.integrations.shortcut.get_custom_field
Full name: shortcut.shortcut_get_custom_field

Parameter	Type	Required	Description
`custom_field_public_id`	string	yes	The unique ID of the CustomField.

update_custom_field Write

Update Custom Field Official Shortcut endpoint: PUT /api/v3/custom-fields/{custom-field-public-id}.

Lua path: app.integrations.shortcut.update_custom_field
Full name: shortcut.shortcut_update_custom_field

Parameter	Type	Required	Description
`custom_field_public_id`	string	yes	The unique ID of the CustomField.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_custom_field Write

Delete Custom Field Official Shortcut endpoint: DELETE /api/v3/custom-fields/{custom-field-public-id}.

Lua path: app.integrations.shortcut.delete_custom_field
Full name: shortcut.shortcut_delete_custom_field

Parameter	Type	Required	Description
`custom_field_public_id`	string	yes	The unique ID of the CustomField.

list_docs Read

List Docs Official Shortcut endpoint: GET /api/v3/documents.

Lua path: app.integrations.shortcut.list_docs
Full name: shortcut.shortcut_list_docs

Parameter	Type	Required	Description
No parameters.

create_doc Write

Create Doc Official Shortcut endpoint: POST /api/v3/documents.

Lua path: app.integrations.shortcut.create_doc
Full name: shortcut.shortcut_create_doc

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

get_doc Read

Get Doc Official Shortcut endpoint: GET /api/v3/documents/{doc-public-id}.

Lua path: app.integrations.shortcut.get_doc
Full name: shortcut.shortcut_get_doc

Parameter	Type	Required	Description
`doc_public_id`	string	yes	The Doc's public ID
`content_format`	string	no	Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response.

update_doc Write

Update Doc Official Shortcut endpoint: PUT /api/v3/documents/{doc-public-id}.

Lua path: app.integrations.shortcut.update_doc
Full name: shortcut.shortcut_update_doc

Parameter	Type	Required	Description
`doc_public_id`	string	yes	The Doc's public ID
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_doc Write

Delete Doc Official Shortcut endpoint: DELETE /api/v3/documents/{doc-public-id}.

Lua path: app.integrations.shortcut.delete_doc
Full name: shortcut.shortcut_delete_doc

Parameter	Type	Required	Description
`doc_public_id`	string	yes	The Doc's public ID
`body`	object	yes	Request body matching the official Shortcut API schema.

list_document_epics Read

List Document Epics Official Shortcut endpoint: GET /api/v3/documents/{doc-public-id}/epics.

Lua path: app.integrations.shortcut.list_document_epics
Full name: shortcut.shortcut_list_document_epics

Parameter	Type	Required	Description
`doc_public_id`	string	yes	The public ID of the Document.

link_document_epic Read

Link Document to Epic Official Shortcut endpoint: PUT /api/v3/documents/{doc-public-id}/epics/{epic-public-id}.

Lua path: app.integrations.shortcut.link_document_epic
Full name: shortcut.shortcut_link_document_to_epic

Parameter	Type	Required	Description
`doc_public_id`	string	yes	The public ID of the Document.
`epic_public_id`	integer	yes	The public ID of the Epic.

unlink_document_from_epic Read

Unlink Document from Epic Official Shortcut endpoint: DELETE /api/v3/documents/{doc-public-id}/epics/{epic-public-id}.

Lua path: app.integrations.shortcut.unlink_document_from_epic
Full name: shortcut.shortcut_unlink_document_from_epic

Parameter	Type	Required	Description
`doc_public_id`	string	yes	The public ID of the Document.
`epic_public_id`	integer	yes	The public ID of the Epic.

load_tiptap_document_json Read

Load Tiptap Document JSON Official Shortcut endpoint: GET /api/v3/documents/{doc-public-id}/tiptap-load.

Lua path: app.integrations.shortcut.load_tiptap_document_json
Full name: shortcut.shortcut_load_tiptap_document_json

Parameter	Type	Required	Description
`doc_public_id`	string	yes	The Doc's public ID
`content_format`	string	no	Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response.

list_entity_templates Read

List Entity Templates Official Shortcut endpoint: GET /api/v3/entity-templates.

Lua path: app.integrations.shortcut.list_entity_templates
Full name: shortcut.shortcut_list_entity_templates

Parameter	Type	Required	Description
No parameters.

create_entity_template Write

Create Entity Template Official Shortcut endpoint: POST /api/v3/entity-templates.

Lua path: app.integrations.shortcut.create_entity_template
Full name: shortcut.shortcut_create_entity_template

Parameter	Type	Required	Description
`body`	object	yes	Request parameters for creating an entirely new entity template.

disable_story_templates Write

Disable Story Templates Official Shortcut endpoint: PUT /api/v3/entity-templates/disable.

Lua path: app.integrations.shortcut.disable_story_templates
Full name: shortcut.shortcut_disable_story_templates

Parameter	Type	Required	Description
No parameters.

enable_story_templates Write

Enable Story Templates Official Shortcut endpoint: PUT /api/v3/entity-templates/enable.

Lua path: app.integrations.shortcut.enable_story_templates
Full name: shortcut.shortcut_enable_story_templates

Parameter	Type	Required	Description
No parameters.

get_entity_template Read

Get Entity Template Official Shortcut endpoint: GET /api/v3/entity-templates/{entity-template-public-id}.

Lua path: app.integrations.shortcut.get_entity_template
Full name: shortcut.shortcut_get_entity_template

Parameter	Type	Required	Description
`entity_template_public_id`	string	yes	The unique ID of the entity template.

update_entity_template Write

Update Entity Template Official Shortcut endpoint: PUT /api/v3/entity-templates/{entity-template-public-id}.

Lua path: app.integrations.shortcut.update_entity_template
Full name: shortcut.shortcut_update_entity_template

Parameter	Type	Required	Description
`entity_template_public_id`	string	yes	The unique ID of the template to be updated.
`body`	object	yes	Request parameters for changing either a template's name or any of the attributes it is designed to pre-populate.

delete_entity_template Write

Delete Entity Template Official Shortcut endpoint: DELETE /api/v3/entity-templates/{entity-template-public-id}.

Lua path: app.integrations.shortcut.delete_entity_template
Full name: shortcut.shortcut_delete_entity_template

Parameter	Type	Required	Description
`entity_template_public_id`	string	yes	The unique ID of the entity template.

get_epic_workflow Read

Get Epic Workflow Official Shortcut endpoint: GET /api/v3/epic-workflow.

Lua path: app.integrations.shortcut.get_epic_workflow
Full name: shortcut.shortcut_get_epic_workflow

Parameter	Type	Required	Description
No parameters.

list_epics Read

List Epics Official Shortcut endpoint: GET /api/v3/epics.

Lua path: app.integrations.shortcut.list_epics
Full name: shortcut.shortcut_list_epics

Parameter	Type	Required	Description
`includes_description`	boolean	no	A true/false boolean indicating whether to return Epics with their descriptions.

create_epic Write

Create Epic Official Shortcut endpoint: POST /api/v3/epics.

Lua path: app.integrations.shortcut.create_epic
Full name: shortcut.shortcut_create_epic

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

list_epics_paginated Read

List Epics Paginated Official Shortcut endpoint: GET /api/v3/epics/paginated.

Lua path: app.integrations.shortcut.list_epics_paginated
Full name: shortcut.shortcut_list_epics_paginated

Parameter	Type	Required	Description
`includes_description`	boolean	no	A true/false boolean indicating whether to return Epics with their descriptions.
`page`	integer	no	The page number to return, starting with 1. Defaults to 1.
`page_size`	integer	no	The number of Epics to return per page. Minimum 1, maximum 250, default 10.

get_epic Read

Get Epic Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}.

Lua path: app.integrations.shortcut.get_epic
Full name: shortcut.shortcut_get_epic

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The unique ID of the Epic.

update_epic Write

Update Epic Official Shortcut endpoint: PUT /api/v3/epics/{epic-public-id}.

Lua path: app.integrations.shortcut.update_epic
Full name: shortcut.shortcut_update_epic

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The unique ID of the Epic.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_epic Write

Delete Epic Official Shortcut endpoint: DELETE /api/v3/epics/{epic-public-id}.

Lua path: app.integrations.shortcut.delete_epic
Full name: shortcut.shortcut_delete_epic

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The unique ID of the Epic.

list_epic_comments Read

List Epic Comments Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/comments.

Lua path: app.integrations.shortcut.list_epic_comments
Full name: shortcut.shortcut_list_epic_comments

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The unique ID of the Epic.

create_epic_comment Write

Create Epic Comment Official Shortcut endpoint: POST /api/v3/epics/{epic-public-id}/comments.

Lua path: app.integrations.shortcut.create_epic_comment
Full name: shortcut.shortcut_create_epic_comment

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The ID of the associated Epic.
`body`	object	yes	Request body matching the official Shortcut API schema.

create_epic_comment_comment Write

Create Epic Comment Comment Official Shortcut endpoint: POST /api/v3/epics/{epic-public-id}/comments/{comment-public-id}.

Lua path: app.integrations.shortcut.create_epic_comment_comment
Full name: shortcut.shortcut_create_epic_comment_comment

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The ID of the associated Epic.
`comment_public_id`	integer	yes	The ID of the parent Epic Comment.
`body`	object	yes	Request body matching the official Shortcut API schema.

get_epic_comment Read

Get Epic Comment Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/comments/{comment-public-id}.

Lua path: app.integrations.shortcut.get_epic_comment
Full name: shortcut.shortcut_get_epic_comment

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The ID of the associated Epic.
`comment_public_id`	integer	yes	The ID of the Comment.

update_epic_comment Write

Update Epic Comment Official Shortcut endpoint: PUT /api/v3/epics/{epic-public-id}/comments/{comment-public-id}.

Lua path: app.integrations.shortcut.update_epic_comment
Full name: shortcut.shortcut_update_epic_comment

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The ID of the associated Epic.
`comment_public_id`	integer	yes	The ID of the Comment.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_epic_comment Write

Delete Epic Comment Official Shortcut endpoint: DELETE /api/v3/epics/{epic-public-id}/comments/{comment-public-id}.

Lua path: app.integrations.shortcut.delete_epic_comment
Full name: shortcut.shortcut_delete_epic_comment

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The ID of the associated Epic.
`comment_public_id`	integer	yes	The ID of the Comment.

list_epic_documents Read

List Epic Documents Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/documents.

Lua path: app.integrations.shortcut.list_epic_documents
Full name: shortcut.shortcut_list_epic_documents

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The unique ID of the Epic.

get_epic_health Read

Get Epic Health Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/health.

Lua path: app.integrations.shortcut.get_epic_health
Full name: shortcut.shortcut_get_epic_health

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The unique ID of the Epic.

create_epic_health Write

Create Epic Health Official Shortcut endpoint: POST /api/v3/epics/{epic-public-id}/health.

Lua path: app.integrations.shortcut.create_epic_health
Full name: shortcut.shortcut_create_epic_health

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The unique ID of the Epic.
`body`	object	yes	Request body matching the official Shortcut API schema.

list_epic_healths Read

List Epic Healths Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/health-history.

Lua path: app.integrations.shortcut.list_epic_healths
Full name: shortcut.shortcut_list_epic_healths

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The unique ID of the Epic.

list_epic_stories Read

List Epic Stories Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/stories.

Lua path: app.integrations.shortcut.list_epic_stories
Full name: shortcut.shortcut_list_epic_stories

Parameter	Type	Required	Description
`epic_public_id`	integer	yes	The unique ID of the Epic.
`includes_description`	boolean	no	A true/false boolean indicating whether to return Stories with their descriptions.

get_external_link_stories Read

Get External Link Stories Official Shortcut endpoint: GET /api/v3/external-link/stories.

Lua path: app.integrations.shortcut.get_external_link_stories
Full name: shortcut.shortcut_get_external_link_stories

Parameter	Type	Required	Description
`external_link`	string	yes	The external link associated with one or more stories.

list_files Read

List Files Official Shortcut endpoint: GET /api/v3/files.

Lua path: app.integrations.shortcut.list_files
Full name: shortcut.shortcut_list_files

Parameter	Type	Required	Description
No parameters.

upload_files Read

Upload Files Official Shortcut endpoint: POST /api/v3/files.

Lua path: app.integrations.shortcut.upload_files
Full name: shortcut.shortcut_upload_files

Parameter	Type	Required	Description
`story_id`	integer	no	The story ID that these files will be associated with.
`file0`	string	yes	A file upload. At least one is required. Provide a local file path for upload.
`file1`	string	no	Optional additional files. Provide a local file path for upload.
`file2`	string	no	Optional additional files. Provide a local file path for upload.
`file3`	string	no	Optional additional files. Provide a local file path for upload.

get_file Read

Get File Official Shortcut endpoint: GET /api/v3/files/{file-public-id}.

Lua path: app.integrations.shortcut.get_file
Full name: shortcut.shortcut_get_file

Parameter	Type	Required	Description
`file_public_id`	integer	yes	The File’s unique ID.

update_file Write

Update File Official Shortcut endpoint: PUT /api/v3/files/{file-public-id}.

Lua path: app.integrations.shortcut.update_file
Full name: shortcut.shortcut_update_file

Parameter	Type	Required	Description
`file_public_id`	integer	yes	The unique ID assigned to the file in Shortcut.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_file Write

Delete File Official Shortcut endpoint: DELETE /api/v3/files/{file-public-id}.

Lua path: app.integrations.shortcut.delete_file
Full name: shortcut.shortcut_delete_file

Parameter	Type	Required	Description
`file_public_id`	integer	yes	The File’s unique ID.

list_groups Read

List Groups Official Shortcut endpoint: GET /api/v3/groups.

Lua path: app.integrations.shortcut.list_groups
Full name: shortcut.shortcut_list_groups

Parameter	Type	Required	Description
`archived`	boolean	no	Filter groups by their archived state. If true, returns only archived groups. If false, returns only unarchived groups. If not provided, returns all groups

create_group Write

Create Group Official Shortcut endpoint: POST /api/v3/groups.

Lua path: app.integrations.shortcut.create_group
Full name: shortcut.shortcut_create_group

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

get_group Read

Get Group Official Shortcut endpoint: GET /api/v3/groups/{group-public-id}.

Lua path: app.integrations.shortcut.get_group
Full name: shortcut.shortcut_get_group

Parameter	Type	Required	Description
`group_public_id`	string	yes	The unique ID of the Group.

update_group Write

Update Group Official Shortcut endpoint: PUT /api/v3/groups/{group-public-id}.

Lua path: app.integrations.shortcut.update_group
Full name: shortcut.shortcut_update_group

Parameter	Type	Required	Description
`group_public_id`	string	yes	The unique ID of the Group.
`body`	object	yes	Request body matching the official Shortcut API schema.

list_group_stories Read

List Group Stories Official Shortcut endpoint: GET /api/v3/groups/{group-public-id}/stories.

Lua path: app.integrations.shortcut.list_group_stories
Full name: shortcut.shortcut_list_group_stories

Parameter	Type	Required	Description
`group_public_id`	string	yes	The unique ID of the Group.
`limit`	integer	no	The maximum number of results to return. (Defaults to 1000, max 1000)
`offset`	integer	no	The offset at which to begin returning results. (Defaults to 0)

update_health Write

Update Health Official Shortcut endpoint: PUT /api/v3/health/{health-public-id}.

Lua path: app.integrations.shortcut.update_health
Full name: shortcut.shortcut_update_health

Parameter	Type	Required	Description
`health_public_id`	string	yes	The unique ID of the Health record.
`body`	object	yes	Request body matching the official Shortcut API schema.

create_generic_integration Write

Create Generic Integration Official Shortcut endpoint: POST /api/v3/integrations/webhook.

Lua path: app.integrations.shortcut.create_generic_integration
Full name: shortcut.shortcut_create_generic_integration

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

get_generic_integration Read

Get Generic Integration Official Shortcut endpoint: GET /api/v3/integrations/webhook/{integration-public-id}.

Lua path: app.integrations.shortcut.get_generic_integration
Full name: shortcut.shortcut_get_generic_integration

Parameter	Type	Required	Description
`integration_public_id`	integer	yes	integration-public-id

delete_generic_integration Write

Delete Generic Integration Official Shortcut endpoint: DELETE /api/v3/integrations/webhook/{integration-public-id}.

Lua path: app.integrations.shortcut.delete_generic_integration
Full name: shortcut.shortcut_delete_generic_integration

Parameter	Type	Required	Description
`integration_public_id`	integer	yes	integration-public-id

list_iterations Read

List Iterations Official Shortcut endpoint: GET /api/v3/iterations.

Lua path: app.integrations.shortcut.list_iterations
Full name: shortcut.shortcut_list_iterations

Parameter	Type	Required	Description
No parameters.

create_iteration Write

Create Iteration Official Shortcut endpoint: POST /api/v3/iterations.

Lua path: app.integrations.shortcut.create_iteration
Full name: shortcut.shortcut_create_iteration

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

disable_iterations Write

Disable Iterations Official Shortcut endpoint: PUT /api/v3/iterations/disable.

Lua path: app.integrations.shortcut.disable_iterations
Full name: shortcut.shortcut_disable_iterations

Parameter	Type	Required	Description
No parameters.

enable_iterations Write

Enable Iterations Official Shortcut endpoint: PUT /api/v3/iterations/enable.

Lua path: app.integrations.shortcut.enable_iterations
Full name: shortcut.shortcut_enable_iterations

Parameter	Type	Required	Description
No parameters.

get_iteration Read

Get Iteration Official Shortcut endpoint: GET /api/v3/iterations/{iteration-public-id}.

Lua path: app.integrations.shortcut.get_iteration
Full name: shortcut.shortcut_get_iteration

Parameter	Type	Required	Description
`iteration_public_id`	integer	yes	The unique ID of the Iteration.

update_iteration Write

Update Iteration Official Shortcut endpoint: PUT /api/v3/iterations/{iteration-public-id}.

Lua path: app.integrations.shortcut.update_iteration
Full name: shortcut.shortcut_update_iteration

Parameter	Type	Required	Description
`iteration_public_id`	integer	yes	The unique ID of the Iteration.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_iteration Write

Delete Iteration Official Shortcut endpoint: DELETE /api/v3/iterations/{iteration-public-id}.

Lua path: app.integrations.shortcut.delete_iteration
Full name: shortcut.shortcut_delete_iteration

Parameter	Type	Required	Description
`iteration_public_id`	integer	yes	The unique ID of the Iteration.

list_iteration_stories Read

List Iteration Stories Official Shortcut endpoint: GET /api/v3/iterations/{iteration-public-id}/stories.

Lua path: app.integrations.shortcut.list_iteration_stories
Full name: shortcut.shortcut_list_iteration_stories

Parameter	Type	Required	Description
`iteration_public_id`	integer	yes	The unique ID of the Iteration.
`includes_description`	boolean	no	A true/false boolean indicating whether to return Stories with their descriptions.

get_key_result Read

Get Key Result Official Shortcut endpoint: GET /api/v3/key-results/{key-result-public-id}.

Lua path: app.integrations.shortcut.get_key_result
Full name: shortcut.shortcut_get_key_result

Parameter	Type	Required	Description
`key_result_public_id`	string	yes	The ID of the Key Result.

update_key_result Write

Update Key Result Official Shortcut endpoint: PUT /api/v3/key-results/{key-result-public-id}.

Lua path: app.integrations.shortcut.update_key_result
Full name: shortcut.shortcut_update_key_result

Parameter	Type	Required	Description
`key_result_public_id`	string	yes	The ID of the Key Result.
`body`	object	yes	Request body matching the official Shortcut API schema.

list_labels Read

List Labels Official Shortcut endpoint: GET /api/v3/labels.

Lua path: app.integrations.shortcut.list_labels
Full name: shortcut.shortcut_list_labels

Parameter	Type	Required	Description
`slim`	boolean	no	A true/false boolean indicating if the slim versions of the Label should be returned.

create_label Write

Create Label Official Shortcut endpoint: POST /api/v3/labels.

Lua path: app.integrations.shortcut.create_label
Full name: shortcut.shortcut_create_label

Parameter	Type	Required	Description
`body`	object	yes	Request parameters for creating a Label on a Shortcut Story.

get_label Read

Get Label Official Shortcut endpoint: GET /api/v3/labels/{label-public-id}.

Lua path: app.integrations.shortcut.get_label
Full name: shortcut.shortcut_get_label

Parameter	Type	Required	Description
`label_public_id`	integer	yes	The unique ID of the Label.

update_label Write

Update Label Official Shortcut endpoint: PUT /api/v3/labels/{label-public-id}.

Lua path: app.integrations.shortcut.update_label
Full name: shortcut.shortcut_update_label

Parameter	Type	Required	Description
`label_public_id`	integer	yes	The unique ID of the Label you wish to update.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_label Write

Delete Label Official Shortcut endpoint: DELETE /api/v3/labels/{label-public-id}.

Lua path: app.integrations.shortcut.delete_label
Full name: shortcut.shortcut_delete_label

Parameter	Type	Required	Description
`label_public_id`	integer	yes	The unique ID of the Label.

list_label_epics Read

List Label Epics Official Shortcut endpoint: GET /api/v3/labels/{label-public-id}/epics.

Lua path: app.integrations.shortcut.list_label_epics
Full name: shortcut.shortcut_list_label_epics

Parameter	Type	Required	Description
`label_public_id`	integer	yes	The unique ID of the Label.

list_label_stories Read

List Label Stories Official Shortcut endpoint: GET /api/v3/labels/{label-public-id}/stories.

Lua path: app.integrations.shortcut.list_label_stories
Full name: shortcut.shortcut_list_label_stories

Parameter	Type	Required	Description
`label_public_id`	integer	yes	The unique ID of the Label.
`includes_description`	boolean	no	A true/false boolean indicating whether to return Stories with their descriptions.

list_linked_files Read

List Linked Files Official Shortcut endpoint: GET /api/v3/linked-files.

Lua path: app.integrations.shortcut.list_linked_files
Full name: shortcut.shortcut_list_linked_files

Parameter	Type	Required	Description
No parameters.

create_linked_file Write

Create Linked File Official Shortcut endpoint: POST /api/v3/linked-files.

Lua path: app.integrations.shortcut.create_linked_file
Full name: shortcut.shortcut_create_linked_file

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

get_linked_file Read

Get Linked File Official Shortcut endpoint: GET /api/v3/linked-files/{linked-file-public-id}.

Lua path: app.integrations.shortcut.get_linked_file
Full name: shortcut.shortcut_get_linked_file

Parameter	Type	Required	Description
`linked_file_public_id`	integer	yes	The unique identifier of the linked file.

update_linked_file Write

Update Linked File Official Shortcut endpoint: PUT /api/v3/linked-files/{linked-file-public-id}.

Lua path: app.integrations.shortcut.update_linked_file
Full name: shortcut.shortcut_update_linked_file

Parameter	Type	Required	Description
`linked_file_public_id`	integer	yes	The unique identifier of the linked file.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_linked_file Write

Delete Linked File Official Shortcut endpoint: DELETE /api/v3/linked-files/{linked-file-public-id}.

Lua path: app.integrations.shortcut.delete_linked_file
Full name: shortcut.shortcut_delete_linked_file

Parameter	Type	Required	Description
`linked_file_public_id`	integer	yes	The unique identifier of the linked file.

get_current_member_info Read

Get Current Member Info Official Shortcut endpoint: GET /api/v3/member.

Lua path: app.integrations.shortcut.get_current_member_info
Full name: shortcut.shortcut_get_current_member_info

Parameter	Type	Required	Description
No parameters.

list_members Read

List Members Official Shortcut endpoint: GET /api/v3/members.

Lua path: app.integrations.shortcut.list_members
Full name: shortcut.shortcut_list_members

Parameter	Type	Required	Description
`org_public_id`	string	no	The unique ID of the Organization to limit the list to.
`disabled`	boolean	no	Filter members by their disabled state. If true, return only disabled members. If false, return only enabled members.

get_member Read

Get Member Official Shortcut endpoint: GET /api/v3/members/{member-public-id}.

Lua path: app.integrations.shortcut.get_member
Full name: shortcut.shortcut_get_member

Parameter	Type	Required	Description
`member_public_id`	string	yes	The Member's unique ID.
`org_public_id`	string	no	The unique ID of the Organization to limit the lookup to.

list_milestones Read

List Milestones Official Shortcut endpoint: GET /api/v3/milestones.

Lua path: app.integrations.shortcut.list_milestones
Full name: shortcut.shortcut_list_milestones

Parameter	Type	Required	Description
No parameters.

create_milestone Write

Create Milestone Official Shortcut endpoint: POST /api/v3/milestones.

Lua path: app.integrations.shortcut.create_milestone
Full name: shortcut.shortcut_create_milestone

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

get_milestone Read

Get Milestone Official Shortcut endpoint: GET /api/v3/milestones/{milestone-public-id}.

Lua path: app.integrations.shortcut.get_milestone
Full name: shortcut.shortcut_get_milestone

Parameter	Type	Required	Description
`milestone_public_id`	integer	yes	The ID of the Milestone.

update_milestone Write

Update Milestone Official Shortcut endpoint: PUT /api/v3/milestones/{milestone-public-id}.

Lua path: app.integrations.shortcut.update_milestone
Full name: shortcut.shortcut_update_milestone

Parameter	Type	Required	Description
`milestone_public_id`	integer	yes	The ID of the Milestone.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_milestone Write

Delete Milestone Official Shortcut endpoint: DELETE /api/v3/milestones/{milestone-public-id}.

Lua path: app.integrations.shortcut.delete_milestone
Full name: shortcut.shortcut_delete_milestone

Parameter	Type	Required	Description
`milestone_public_id`	integer	yes	The ID of the Milestone.

list_milestone_epics Read

List Milestone Epics Official Shortcut endpoint: GET /api/v3/milestones/{milestone-public-id}/epics.

Lua path: app.integrations.shortcut.list_milestone_epics
Full name: shortcut.shortcut_list_milestone_epics

Parameter	Type	Required	Description
`milestone_public_id`	integer	yes	The ID of the Milestone.

list_objectives Read

List Objectives Official Shortcut endpoint: GET /api/v3/objectives.

Lua path: app.integrations.shortcut.list_objectives
Full name: shortcut.shortcut_list_objectives

Parameter	Type	Required	Description
No parameters.

create_objective Write

Create Objective Official Shortcut endpoint: POST /api/v3/objectives.

Lua path: app.integrations.shortcut.create_objective
Full name: shortcut.shortcut_create_objective

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

get_objective Read

Get Objective Official Shortcut endpoint: GET /api/v3/objectives/{objective-public-id}.

Lua path: app.integrations.shortcut.get_objective
Full name: shortcut.shortcut_get_objective

Parameter	Type	Required	Description
`objective_public_id`	integer	yes	The ID of the Objective.

update_objective Write

Update Objective Official Shortcut endpoint: PUT /api/v3/objectives/{objective-public-id}.

Lua path: app.integrations.shortcut.update_objective
Full name: shortcut.shortcut_update_objective

Parameter	Type	Required	Description
`objective_public_id`	integer	yes	The ID of the Objective.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_objective Write

Delete Objective Official Shortcut endpoint: DELETE /api/v3/objectives/{objective-public-id}.

Lua path: app.integrations.shortcut.delete_objective
Full name: shortcut.shortcut_delete_objective

Parameter	Type	Required	Description
`objective_public_id`	integer	yes	The ID of the Objective.

list_objective_epics Read

List Objective Epics Official Shortcut endpoint: GET /api/v3/objectives/{objective-public-id}/epics.

Lua path: app.integrations.shortcut.list_objective_epics
Full name: shortcut.shortcut_list_objective_epics

Parameter	Type	Required	Description
`objective_public_id`	integer	yes	The ID of the Objective.

get_objective_health Read

Get Objective Health Official Shortcut endpoint: GET /api/v3/objectives/{objective-public-id}/health.

Lua path: app.integrations.shortcut.get_objective_health
Full name: shortcut.shortcut_get_objective_health

Parameter	Type	Required	Description
`objective_public_id`	integer	yes	The unique ID of the Objective.

create_objective_health Write

Create Objective Health Official Shortcut endpoint: POST /api/v3/objectives/{objective-public-id}/health.

Lua path: app.integrations.shortcut.create_objective_health
Full name: shortcut.shortcut_create_objective_health

Parameter	Type	Required	Description
`objective_public_id`	integer	yes	The unique ID of the Objective.
`body`	object	yes	Request body matching the official Shortcut API schema.

list_objective_healths Read

List Objective Healths Official Shortcut endpoint: GET /api/v3/objectives/{objective-public-id}/health-history.

Lua path: app.integrations.shortcut.list_objective_healths
Full name: shortcut.shortcut_list_objective_healths

Parameter	Type	Required	Description
`objective_public_id`	integer	yes	The unique ID of the Objective.

list_projects Read

List Projects Official Shortcut endpoint: GET /api/v3/projects.

Lua path: app.integrations.shortcut.list_projects
Full name: shortcut.shortcut_list_projects

Parameter	Type	Required	Description
No parameters.

create_project Write

Create Project Official Shortcut endpoint: POST /api/v3/projects.

Lua path: app.integrations.shortcut.create_project
Full name: shortcut.shortcut_create_project

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

get_project Read

Get Project Official Shortcut endpoint: GET /api/v3/projects/{project-public-id}.

Lua path: app.integrations.shortcut.get_project
Full name: shortcut.shortcut_get_project

Parameter	Type	Required	Description
`project_public_id`	integer	yes	The unique ID of the Project.

update_project Write

Update Project Official Shortcut endpoint: PUT /api/v3/projects/{project-public-id}.

Lua path: app.integrations.shortcut.update_project
Full name: shortcut.shortcut_update_project

Parameter	Type	Required	Description
`project_public_id`	integer	yes	The unique ID of the Project.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_project Write

Delete Project Official Shortcut endpoint: DELETE /api/v3/projects/{project-public-id}.

Lua path: app.integrations.shortcut.delete_project
Full name: shortcut.shortcut_delete_project

Parameter	Type	Required	Description
`project_public_id`	integer	yes	The unique ID of the Project.

list_stories Read

List Stories Official Shortcut endpoint: GET /api/v3/projects/{project-public-id}/stories.

Lua path: app.integrations.shortcut.list_stories
Full name: shortcut.shortcut_list_stories

Parameter	Type	Required	Description
`project_public_id`	integer	yes	The unique ID of the Project.
`includes_description`	boolean	no	A true/false boolean indicating whether to return Stories with their descriptions.

list_repositories Read

List Repositories Official Shortcut endpoint: GET /api/v3/repositories.

Lua path: app.integrations.shortcut.list_repositories
Full name: shortcut.shortcut_list_repositories

Parameter	Type	Required	Description
No parameters.

get_repository Read

Get Repository Official Shortcut endpoint: GET /api/v3/repositories/{repo-public-id}.

Lua path: app.integrations.shortcut.get_repository
Full name: shortcut.shortcut_get_repository

Parameter	Type	Required	Description
`repo_public_id`	integer	yes	The unique ID of the Repository.

search Read

Search Official Shortcut endpoint: GET /api/v3/search.

Lua path: app.integrations.shortcut.search
Full name: shortcut.shortcut_search

Parameter	Type	Required	Description
`query`	string	yes	See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
`page_size`	integer	no	The number of search results to include in a page. Minimum of 1 and maximum of 250.
`detail`	string	no	The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
`next`	string	no	The next page token.
`entity_types`	array	no	A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

search_documents Read

Search Documents Official Shortcut endpoint: GET /api/v3/search/documents.

Lua path: app.integrations.shortcut.search_documents
Full name: shortcut.shortcut_search_documents

Parameter	Type	Required	Description
`title`	string	yes	Search text to match against document titles. Supports fuzzy matching. Required.
`archived`	boolean	no	When true, find archived documents. When false, find non-archived documents.
`created_by_me`	boolean	no	When true, find documents created by the current user. When false, find documents NOT created by current user.
`followed_by_me`	boolean	no	When true, find documents that the current user is following. When false, find documents NOT followed.
`page_size`	integer	no	The number of search results to include in a page. Minimum of 1 and maximum of 250.
`next`	string	no	The next page token.

search_epics Read

Search Epics Official Shortcut endpoint: GET /api/v3/search/epics.

Lua path: app.integrations.shortcut.search_epics
Full name: shortcut.shortcut_search_epics

Parameter	Type	Required	Description
`query`	string	yes	See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
`page_size`	integer	no	The number of search results to include in a page. Minimum of 1 and maximum of 250.
`detail`	string	no	The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
`next`	string	no	The next page token.
`entity_types`	array	no	A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

search_iterations Read

Search Iterations Official Shortcut endpoint: GET /api/v3/search/iterations.

Lua path: app.integrations.shortcut.search_iterations
Full name: shortcut.shortcut_search_iterations

Parameter	Type	Required	Description
`query`	string	yes	See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
`page_size`	integer	no	The number of search results to include in a page. Minimum of 1 and maximum of 250.
`detail`	string	no	The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
`next`	string	no	The next page token.
`entity_types`	array	no	A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

search_milestones Read

Search Milestones Official Shortcut endpoint: GET /api/v3/search/milestones.

Lua path: app.integrations.shortcut.search_milestones
Full name: shortcut.shortcut_search_milestones

Parameter	Type	Required	Description
`query`	string	yes	See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
`page_size`	integer	no	The number of search results to include in a page. Minimum of 1 and maximum of 250.
`detail`	string	no	The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
`next`	string	no	The next page token.
`entity_types`	array	no	A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

search_objectives Read

Search Objectives Official Shortcut endpoint: GET /api/v3/search/objectives.

Lua path: app.integrations.shortcut.search_objectives
Full name: shortcut.shortcut_search_objectives

Parameter	Type	Required	Description
`query`	string	yes	See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
`page_size`	integer	no	The number of search results to include in a page. Minimum of 1 and maximum of 250.
`detail`	string	no	The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
`next`	string	no	The next page token.
`entity_types`	array	no	A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

search_stories Read

Search Stories Official Shortcut endpoint: GET /api/v3/search/stories.

Lua path: app.integrations.shortcut.search_stories
Full name: shortcut.shortcut_search_stories

Parameter	Type	Required	Description
`query`	string	yes	See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
`page_size`	integer	no	The number of search results to include in a page. Minimum of 1 and maximum of 250.
`detail`	string	no	The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
`next`	string	no	The next page token.
`entity_types`	array	no	A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

create_story Write

Create Story Official Shortcut endpoint: POST /api/v3/stories.

Lua path: app.integrations.shortcut.create_story
Full name: shortcut.shortcut_create_story

Parameter	Type	Required	Description
`body`	object	yes	Request parameters for creating a story.

create_multiple_stories Write

Create Multiple Stories Official Shortcut endpoint: POST /api/v3/stories/bulk.

Lua path: app.integrations.shortcut.create_multiple_stories
Full name: shortcut.shortcut_create_multiple_stories

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

update_multiple_stories Write

Update Multiple Stories Official Shortcut endpoint: PUT /api/v3/stories/bulk.

Lua path: app.integrations.shortcut.update_multiple_stories
Full name: shortcut.shortcut_update_multiple_stories

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_multiple_stories Write

Delete Multiple Stories Official Shortcut endpoint: DELETE /api/v3/stories/bulk.

Lua path: app.integrations.shortcut.delete_multiple_stories
Full name: shortcut.shortcut_delete_multiple_stories

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

create_story_from_template Write

Create Story From Template Official Shortcut endpoint: POST /api/v3/stories/from-template.

Lua path: app.integrations.shortcut.create_story_from_template
Full name: shortcut.shortcut_create_story_from_template

Parameter	Type	Required	Description
`body`	object	yes	Request parameters for creating a story from a story template. These parameters are merged with the values derived from the template.

query_stories Read

Query Stories Official Shortcut endpoint: POST /api/v3/stories/search.

Lua path: app.integrations.shortcut.query_stories
Full name: shortcut.shortcut_query_stories

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

get_story Read

Get Story Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}.

Lua path: app.integrations.shortcut.get_story
Full name: shortcut.shortcut_get_story

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story.

update_story Write

Update Story Official Shortcut endpoint: PUT /api/v3/stories/{story-public-id}.

Lua path: app.integrations.shortcut.update_story
Full name: shortcut.shortcut_update_story

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The unique identifier of this story.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_story Write

Delete Story Official Shortcut endpoint: DELETE /api/v3/stories/{story-public-id}.

Lua path: app.integrations.shortcut.delete_story
Full name: shortcut.shortcut_delete_story

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story.

list_story_comment Read

List Story Comment Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}/comments.

Lua path: app.integrations.shortcut.list_story_comment
Full name: shortcut.shortcut_list_story_comment

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story that the Comment is in.

create_story_comment Write

Create Story Comment Official Shortcut endpoint: POST /api/v3/stories/{story-public-id}/comments.

Lua path: app.integrations.shortcut.create_story_comment
Full name: shortcut.shortcut_create_story_comment

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story that the Comment is in.
`body`	object	yes	Request body matching the official Shortcut API schema.

get_story_comment Read

Get Story Comment Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}/comments/{comment-public-id}.

Lua path: app.integrations.shortcut.get_story_comment
Full name: shortcut.shortcut_get_story_comment

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story that the Comment is in.
`comment_public_id`	integer	yes	The ID of the Comment.

update_story_comment Write

Update Story Comment Official Shortcut endpoint: PUT /api/v3/stories/{story-public-id}/comments/{comment-public-id}.

Lua path: app.integrations.shortcut.update_story_comment
Full name: shortcut.shortcut_update_story_comment

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story that the Comment is in.
`comment_public_id`	integer	yes	The ID of the Comment
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_story_comment Write

Delete Story Comment Official Shortcut endpoint: DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id}.

Lua path: app.integrations.shortcut.delete_story_comment
Full name: shortcut.shortcut_delete_story_comment

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story that the Comment is in.
`comment_public_id`	integer	yes	The ID of the Comment.

create_story_reaction Write

Create Story Reaction Official Shortcut endpoint: POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions.

Lua path: app.integrations.shortcut.create_story_reaction
Full name: shortcut.shortcut_create_story_reaction

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story that the Comment is in.
`comment_public_id`	integer	yes	The ID of the Comment.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_story_reaction Write

Delete Story Reaction Official Shortcut endpoint: DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions.

Lua path: app.integrations.shortcut.delete_story_reaction
Full name: shortcut.shortcut_delete_story_reaction

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story that the Comment is in.
`comment_public_id`	integer	yes	The ID of the Comment.
`body`	object	yes	Request body matching the official Shortcut API schema.

unlink_comment_thread_from_slack Read

Unlink Comment thread from Slack Official Shortcut endpoint: POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack.

Lua path: app.integrations.shortcut.unlink_comment_thread_from_slack
Full name: shortcut.shortcut_unlink_comment_thread_from_slack

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story to unlink.
`comment_public_id`	integer	yes	The ID of the Comment to unlink.

story_history Read

Story History Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}/history.

Lua path: app.integrations.shortcut.story_history
Full name: shortcut.shortcut_story_history

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story.

list_story_sub_tasks Read

List Story Sub tasks Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}/sub-tasks.

Lua path: app.integrations.shortcut.list_story_sub_tasks
Full name: shortcut.shortcut_list_story_sub_tasks

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story.

create_task Write

Create Task Official Shortcut endpoint: POST /api/v3/stories/{story-public-id}/tasks.

Lua path: app.integrations.shortcut.create_task
Full name: shortcut.shortcut_create_task

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The ID of the Story that the Task will be in.
`body`	object	yes	Request body matching the official Shortcut API schema.

get_task Read

Get Task Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}/tasks/{task-public-id}.

Lua path: app.integrations.shortcut.get_task
Full name: shortcut.shortcut_get_task

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The unique ID of the Story this Task is associated with.
`task_public_id`	integer	yes	The unique ID of the Task.

update_task Write

Update Task Official Shortcut endpoint: PUT /api/v3/stories/{story-public-id}/tasks/{task-public-id}.

Lua path: app.integrations.shortcut.update_task
Full name: shortcut.shortcut_update_task

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The unique identifier of the parent Story.
`task_public_id`	integer	yes	The unique identifier of the Task you wish to update.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_task Write

Delete Task Official Shortcut endpoint: DELETE /api/v3/stories/{story-public-id}/tasks/{task-public-id}.

Lua path: app.integrations.shortcut.delete_task
Full name: shortcut.shortcut_delete_task

Parameter	Type	Required	Description
`story_public_id`	integer	yes	The unique ID of the Story this Task is associated with.
`task_public_id`	integer	yes	The unique ID of the Task.

create_story_link Write

Create Story Link Official Shortcut endpoint: POST /api/v3/story-links.

Lua path: app.integrations.shortcut.create_story_link
Full name: shortcut.shortcut_create_story_link

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Shortcut API schema.

get_story_link Read

Get Story Link Official Shortcut endpoint: GET /api/v3/story-links/{story-link-public-id}.

Lua path: app.integrations.shortcut.get_story_link
Full name: shortcut.shortcut_get_story_link

Parameter	Type	Required	Description
`story_link_public_id`	integer	yes	The unique ID of the Story Link.

update_story_link Write

Update Story Link Official Shortcut endpoint: PUT /api/v3/story-links/{story-link-public-id}.

Lua path: app.integrations.shortcut.update_story_link
Full name: shortcut.shortcut_update_story_link

Parameter	Type	Required	Description
`story_link_public_id`	integer	yes	The unique ID of the Story Link.
`body`	object	yes	Request body matching the official Shortcut API schema.

delete_story_link Write

Delete Story Link Official Shortcut endpoint: DELETE /api/v3/story-links/{story-link-public-id}.

Lua path: app.integrations.shortcut.delete_story_link
Full name: shortcut.shortcut_delete_story_link

Parameter	Type	Required	Description
`story_link_public_id`	integer	yes	The unique ID of the Story Link.

list_workflows Read

List Workflows Official Shortcut endpoint: GET /api/v3/workflows.

Lua path: app.integrations.shortcut.list_workflows
Full name: shortcut.shortcut_list_workflows

Parameter	Type	Required	Description
No parameters.

get_workflow Read

Get Workflow Official Shortcut endpoint: GET /api/v3/workflows/{workflow-public-id}.

Lua path: app.integrations.shortcut.get_workflow
Full name: shortcut.shortcut_get_workflow

Parameter	Type	Required	Description
`workflow_public_id`	integer	yes	The ID of the Workflow.