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 CLI for AI Agents

Use the Shortcut CLI from KosmoKrator to call Shortcut tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Shortcut CLI Setup

Shortcut can be configured headlessly with `kosmokrator integrations:configure shortcut`.

Install, configure, and verify

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure shortcut --enable --read allow --write ask --json
kosmokrator integrations:doctor shortcut --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

No credentials are required.

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call shortcut.shortcut_list_categories '{}' --json

Provider shortcut

kosmo integrations:shortcut shortcut_list_categories '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs shortcut --json
kosmo integrations:docs shortcut.shortcut_list_categories --json
kosmo integrations:schema shortcut.shortcut_list_categories --json
kosmo integrations:search "Shortcut" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`shortcut.shortcut_list_categories`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_categories '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_categories '{}' --json

`shortcut.shortcut_create_category`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_category '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_category '{"body":"example_body"}' --json

`shortcut.shortcut_get_category`

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

Read read

Parameters: category_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_category '{"category_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_category '{"category_public_id":1}' --json

`shortcut.shortcut_update_category`

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

Write write

Parameters: category_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_category '{"category_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_category '{"category_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_category`

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

Write write

Parameters: category_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_category '{"category_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_category '{"category_public_id":1}' --json

`shortcut.shortcut_list_category_milestones`

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

Read read

Parameters: category_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_category_milestones '{"category_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_category_milestones '{"category_public_id":1}' --json

`shortcut.shortcut_list_category_objectives`

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

Read read

Parameters: category_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_category_objectives '{"category_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_category_objectives '{"category_public_id":1}' --json

`shortcut.shortcut_list_custom_fields`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_custom_fields '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_custom_fields '{}' --json

`shortcut.shortcut_get_custom_field`

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

Read read

Parameters: custom_field_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_custom_field '{"custom_field_public_id":"example_custom_field_public_id"}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_custom_field '{"custom_field_public_id":"example_custom_field_public_id"}' --json

`shortcut.shortcut_update_custom_field`

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

Write write

Parameters: custom_field_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_custom_field '{"custom_field_public_id":"example_custom_field_public_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_custom_field '{"custom_field_public_id":"example_custom_field_public_id","body":"example_body"}' --json

`shortcut.shortcut_delete_custom_field`

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

Write write

Parameters: custom_field_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_custom_field '{"custom_field_public_id":"example_custom_field_public_id"}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_custom_field '{"custom_field_public_id":"example_custom_field_public_id"}' --json

`shortcut.shortcut_list_docs`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_docs '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_docs '{}' --json

`shortcut.shortcut_create_doc`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_doc '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_doc '{"body":"example_body"}' --json

`shortcut.shortcut_get_doc`

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

Read read

Parameters: doc_public_id, content_format

Generic call

kosmo integrations:call shortcut.shortcut_get_doc '{"doc_public_id":"example_doc_public_id","content_format":"example_content_format"}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_doc '{"doc_public_id":"example_doc_public_id","content_format":"example_content_format"}' --json

`shortcut.shortcut_update_doc`

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

Write write

Parameters: doc_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_doc '{"doc_public_id":"example_doc_public_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_doc '{"doc_public_id":"example_doc_public_id","body":"example_body"}' --json

`shortcut.shortcut_delete_doc`

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

Write write

Parameters: doc_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_delete_doc '{"doc_public_id":"example_doc_public_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_doc '{"doc_public_id":"example_doc_public_id","body":"example_body"}' --json

`shortcut.shortcut_list_document_epics`

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

Read read

Parameters: doc_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_document_epics '{"doc_public_id":"example_doc_public_id"}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_document_epics '{"doc_public_id":"example_doc_public_id"}' --json

`shortcut.shortcut_link_document_to_epic`

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

Read read

Parameters: doc_public_id, epic_public_id

Generic call

kosmo integrations:call shortcut.shortcut_link_document_to_epic '{"doc_public_id":"example_doc_public_id","epic_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_link_document_to_epic '{"doc_public_id":"example_doc_public_id","epic_public_id":1}' --json

`shortcut.shortcut_unlink_document_from_epic`

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

Read read

Parameters: doc_public_id, epic_public_id

Generic call

kosmo integrations:call shortcut.shortcut_unlink_document_from_epic '{"doc_public_id":"example_doc_public_id","epic_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_unlink_document_from_epic '{"doc_public_id":"example_doc_public_id","epic_public_id":1}' --json

`shortcut.shortcut_load_tiptap_document_json`

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

Read read

Parameters: doc_public_id, content_format

Generic call

kosmo integrations:call shortcut.shortcut_load_tiptap_document_json '{"doc_public_id":"example_doc_public_id","content_format":"example_content_format"}' --json

Shortcut

kosmo integrations:shortcut shortcut_load_tiptap_document_json '{"doc_public_id":"example_doc_public_id","content_format":"example_content_format"}' --json

`shortcut.shortcut_list_entity_templates`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_entity_templates '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_entity_templates '{}' --json

`shortcut.shortcut_create_entity_template`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_entity_template '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_entity_template '{"body":"example_body"}' --json

`shortcut.shortcut_disable_story_templates`

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

Write write

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_disable_story_templates '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_disable_story_templates '{}' --json

`shortcut.shortcut_enable_story_templates`

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

Write write

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_enable_story_templates '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_enable_story_templates '{}' --json

`shortcut.shortcut_get_entity_template`

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

Read read

Parameters: entity_template_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_entity_template '{"entity_template_public_id":"example_entity_template_public_id"}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_entity_template '{"entity_template_public_id":"example_entity_template_public_id"}' --json

`shortcut.shortcut_update_entity_template`

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

Write write

Parameters: entity_template_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_entity_template '{"entity_template_public_id":"example_entity_template_public_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_entity_template '{"entity_template_public_id":"example_entity_template_public_id","body":"example_body"}' --json

`shortcut.shortcut_delete_entity_template`

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

Write write

Parameters: entity_template_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_entity_template '{"entity_template_public_id":"example_entity_template_public_id"}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_entity_template '{"entity_template_public_id":"example_entity_template_public_id"}' --json

`shortcut.shortcut_get_epic_workflow`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_get_epic_workflow '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_epic_workflow '{}' --json

`shortcut.shortcut_list_epics`

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

Read read

Parameters: includes_description

Generic call

kosmo integrations:call shortcut.shortcut_list_epics '{"includes_description":true}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_epics '{"includes_description":true}' --json

`shortcut.shortcut_create_epic`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_epic '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_epic '{"body":"example_body"}' --json

`shortcut.shortcut_list_epics_paginated`

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

Read read

Parameters: includes_description, page, page_size

Generic call

kosmo integrations:call shortcut.shortcut_list_epics_paginated '{"includes_description":true,"page":1,"page_size":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_epics_paginated '{"includes_description":true,"page":1,"page_size":1}' --json

`shortcut.shortcut_get_epic`

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

Read read

Parameters: epic_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_epic '{"epic_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_epic '{"epic_public_id":1}' --json

`shortcut.shortcut_update_epic`

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

Write write

Parameters: epic_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_epic '{"epic_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_epic '{"epic_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_epic`

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

Write write

Parameters: epic_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_epic '{"epic_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_epic '{"epic_public_id":1}' --json

`shortcut.shortcut_list_epic_comments`

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

Read read

Parameters: epic_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_epic_comments '{"epic_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_epic_comments '{"epic_public_id":1}' --json

`shortcut.shortcut_create_epic_comment`

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

Write write

Parameters: epic_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_create_epic_comment '{"epic_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_epic_comment '{"epic_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_create_epic_comment_comment`

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

Write write

Parameters: epic_public_id, comment_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_create_epic_comment_comment '{"epic_public_id":1,"comment_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_epic_comment_comment '{"epic_public_id":1,"comment_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_get_epic_comment`

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

Read read

Parameters: epic_public_id, comment_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_epic_comment '{"epic_public_id":1,"comment_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_epic_comment '{"epic_public_id":1,"comment_public_id":1}' --json

`shortcut.shortcut_update_epic_comment`

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

Write write

Parameters: epic_public_id, comment_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_epic_comment '{"epic_public_id":1,"comment_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_epic_comment '{"epic_public_id":1,"comment_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_epic_comment`

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

Write write

Parameters: epic_public_id, comment_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_epic_comment '{"epic_public_id":1,"comment_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_epic_comment '{"epic_public_id":1,"comment_public_id":1}' --json

`shortcut.shortcut_list_epic_documents`

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

Read read

Parameters: epic_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_epic_documents '{"epic_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_epic_documents '{"epic_public_id":1}' --json

`shortcut.shortcut_get_epic_health`

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

Read read

Parameters: epic_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_epic_health '{"epic_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_epic_health '{"epic_public_id":1}' --json

`shortcut.shortcut_create_epic_health`

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

Write write

Parameters: epic_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_create_epic_health '{"epic_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_epic_health '{"epic_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_list_epic_healths`

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

Read read

Parameters: epic_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_epic_healths '{"epic_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_epic_healths '{"epic_public_id":1}' --json

`shortcut.shortcut_list_epic_stories`

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

Read read

Parameters: epic_public_id, includes_description

Generic call

kosmo integrations:call shortcut.shortcut_list_epic_stories '{"epic_public_id":1,"includes_description":true}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_epic_stories '{"epic_public_id":1,"includes_description":true}' --json

`shortcut.shortcut_get_external_link_stories`

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

Read read

Parameters: external_link

Generic call

kosmo integrations:call shortcut.shortcut_get_external_link_stories '{"external_link":"example_external_link"}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_external_link_stories '{"external_link":"example_external_link"}' --json

`shortcut.shortcut_list_files`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_files '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_files '{}' --json

`shortcut.shortcut_upload_files`

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

Read read

Parameters: story_id, file0, file1, file2, file3

Generic call

kosmo integrations:call shortcut.shortcut_upload_files '{"story_id":1,"file0":"example_file0","file1":"example_file1","file2":"example_file2","file3":"example_file3"}' --json

Shortcut

kosmo integrations:shortcut shortcut_upload_files '{"story_id":1,"file0":"example_file0","file1":"example_file1","file2":"example_file2","file3":"example_file3"}' --json

`shortcut.shortcut_get_file`

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

Read read

Parameters: file_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_file '{"file_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_file '{"file_public_id":1}' --json

`shortcut.shortcut_update_file`

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

Write write

Parameters: file_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_file '{"file_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_file '{"file_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_file`

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

Write write

Parameters: file_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_file '{"file_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_file '{"file_public_id":1}' --json

`shortcut.shortcut_list_groups`

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

Read read

Parameters: archived

Generic call

kosmo integrations:call shortcut.shortcut_list_groups '{"archived":true}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_groups '{"archived":true}' --json

`shortcut.shortcut_create_group`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_group '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_group '{"body":"example_body"}' --json

`shortcut.shortcut_get_group`

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

Read read

Parameters: group_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_group '{"group_public_id":"example_group_public_id"}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_group '{"group_public_id":"example_group_public_id"}' --json

`shortcut.shortcut_update_group`

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

Write write

Parameters: group_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_group '{"group_public_id":"example_group_public_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_group '{"group_public_id":"example_group_public_id","body":"example_body"}' --json

`shortcut.shortcut_list_group_stories`

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

Read read

Parameters: group_public_id, limit, offset

Generic call

kosmo integrations:call shortcut.shortcut_list_group_stories '{"group_public_id":"example_group_public_id","limit":1,"offset":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_group_stories '{"group_public_id":"example_group_public_id","limit":1,"offset":1}' --json

`shortcut.shortcut_update_health`

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

Write write

Parameters: health_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_health '{"health_public_id":"example_health_public_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_health '{"health_public_id":"example_health_public_id","body":"example_body"}' --json

`shortcut.shortcut_create_generic_integration`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_generic_integration '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_generic_integration '{"body":"example_body"}' --json

`shortcut.shortcut_get_generic_integration`

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

Read read

Parameters: integration_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_generic_integration '{"integration_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_generic_integration '{"integration_public_id":1}' --json

`shortcut.shortcut_delete_generic_integration`

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

Write write

Parameters: integration_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_generic_integration '{"integration_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_generic_integration '{"integration_public_id":1}' --json

`shortcut.shortcut_list_iterations`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_iterations '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_iterations '{}' --json

`shortcut.shortcut_create_iteration`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_iteration '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_iteration '{"body":"example_body"}' --json

`shortcut.shortcut_disable_iterations`

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

Write write

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_disable_iterations '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_disable_iterations '{}' --json

`shortcut.shortcut_enable_iterations`

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

Write write

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_enable_iterations '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_enable_iterations '{}' --json

`shortcut.shortcut_get_iteration`

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

Read read

Parameters: iteration_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_iteration '{"iteration_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_iteration '{"iteration_public_id":1}' --json

`shortcut.shortcut_update_iteration`

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

Write write

Parameters: iteration_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_iteration '{"iteration_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_iteration '{"iteration_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_iteration`

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

Write write

Parameters: iteration_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_iteration '{"iteration_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_iteration '{"iteration_public_id":1}' --json

`shortcut.shortcut_list_iteration_stories`

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

Read read

Parameters: iteration_public_id, includes_description

Generic call

kosmo integrations:call shortcut.shortcut_list_iteration_stories '{"iteration_public_id":1,"includes_description":true}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_iteration_stories '{"iteration_public_id":1,"includes_description":true}' --json

`shortcut.shortcut_get_key_result`

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

Read read

Parameters: key_result_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_key_result '{"key_result_public_id":"example_key_result_public_id"}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_key_result '{"key_result_public_id":"example_key_result_public_id"}' --json

`shortcut.shortcut_update_key_result`

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

Write write

Parameters: key_result_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_key_result '{"key_result_public_id":"example_key_result_public_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_key_result '{"key_result_public_id":"example_key_result_public_id","body":"example_body"}' --json

`shortcut.shortcut_list_labels`

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

Read read

Parameters: slim

Generic call

kosmo integrations:call shortcut.shortcut_list_labels '{"slim":true}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_labels '{"slim":true}' --json

`shortcut.shortcut_create_label`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_label '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_label '{"body":"example_body"}' --json

`shortcut.shortcut_get_label`

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

Read read

Parameters: label_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_label '{"label_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_label '{"label_public_id":1}' --json

`shortcut.shortcut_update_label`

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

Write write

Parameters: label_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_label '{"label_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_label '{"label_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_label`

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

Write write

Parameters: label_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_label '{"label_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_label '{"label_public_id":1}' --json

`shortcut.shortcut_list_label_epics`

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

Read read

Parameters: label_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_label_epics '{"label_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_label_epics '{"label_public_id":1}' --json

`shortcut.shortcut_list_label_stories`

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

Read read

Parameters: label_public_id, includes_description

Generic call

kosmo integrations:call shortcut.shortcut_list_label_stories '{"label_public_id":1,"includes_description":true}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_label_stories '{"label_public_id":1,"includes_description":true}' --json

`shortcut.shortcut_list_linked_files`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_linked_files '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_linked_files '{}' --json

`shortcut.shortcut_create_linked_file`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_linked_file '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_linked_file '{"body":"example_body"}' --json

`shortcut.shortcut_get_linked_file`

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

Read read

Parameters: linked_file_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_linked_file '{"linked_file_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_linked_file '{"linked_file_public_id":1}' --json

`shortcut.shortcut_update_linked_file`

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

Write write

Parameters: linked_file_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_linked_file '{"linked_file_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_linked_file '{"linked_file_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_linked_file`

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

Write write

Parameters: linked_file_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_linked_file '{"linked_file_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_linked_file '{"linked_file_public_id":1}' --json

`shortcut.shortcut_get_current_member_info`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_get_current_member_info '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_current_member_info '{}' --json

`shortcut.shortcut_list_members`

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

Read read

Parameters: org_public_id, disabled

Generic call

kosmo integrations:call shortcut.shortcut_list_members '{"org_public_id":"example_org_public_id","disabled":true}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_members '{"org_public_id":"example_org_public_id","disabled":true}' --json

`shortcut.shortcut_get_member`

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

Read read

Parameters: member_public_id, org_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_member '{"member_public_id":"example_member_public_id","org_public_id":"example_org_public_id"}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_member '{"member_public_id":"example_member_public_id","org_public_id":"example_org_public_id"}' --json

`shortcut.shortcut_list_milestones`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_milestones '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_milestones '{}' --json

`shortcut.shortcut_create_milestone`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_milestone '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_milestone '{"body":"example_body"}' --json

`shortcut.shortcut_get_milestone`

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

Read read

Parameters: milestone_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_milestone '{"milestone_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_milestone '{"milestone_public_id":1}' --json

`shortcut.shortcut_update_milestone`

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

Write write

Parameters: milestone_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_milestone '{"milestone_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_milestone '{"milestone_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_milestone`

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

Write write

Parameters: milestone_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_milestone '{"milestone_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_milestone '{"milestone_public_id":1}' --json

`shortcut.shortcut_list_milestone_epics`

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

Read read

Parameters: milestone_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_milestone_epics '{"milestone_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_milestone_epics '{"milestone_public_id":1}' --json

`shortcut.shortcut_list_objectives`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_objectives '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_objectives '{}' --json

`shortcut.shortcut_create_objective`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_objective '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_objective '{"body":"example_body"}' --json

`shortcut.shortcut_get_objective`

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

Read read

Parameters: objective_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_objective '{"objective_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_objective '{"objective_public_id":1}' --json

`shortcut.shortcut_update_objective`

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

Write write

Parameters: objective_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_objective '{"objective_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_objective '{"objective_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_objective`

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

Write write

Parameters: objective_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_objective '{"objective_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_objective '{"objective_public_id":1}' --json

`shortcut.shortcut_list_objective_epics`

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

Read read

Parameters: objective_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_objective_epics '{"objective_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_objective_epics '{"objective_public_id":1}' --json

`shortcut.shortcut_get_objective_health`

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

Read read

Parameters: objective_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_objective_health '{"objective_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_objective_health '{"objective_public_id":1}' --json

`shortcut.shortcut_create_objective_health`

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

Write write

Parameters: objective_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_create_objective_health '{"objective_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_objective_health '{"objective_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_list_objective_healths`

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

Read read

Parameters: objective_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_objective_healths '{"objective_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_objective_healths '{"objective_public_id":1}' --json

`shortcut.shortcut_list_projects`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_projects '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_projects '{}' --json

`shortcut.shortcut_create_project`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_project '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_project '{"body":"example_body"}' --json

`shortcut.shortcut_get_project`

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

Read read

Parameters: project_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_project '{"project_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_project '{"project_public_id":1}' --json

`shortcut.shortcut_update_project`

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

Write write

Parameters: project_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_project '{"project_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_project '{"project_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_project`

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

Write write

Parameters: project_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_project '{"project_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_project '{"project_public_id":1}' --json

`shortcut.shortcut_list_stories`

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

Read read

Parameters: project_public_id, includes_description

Generic call

kosmo integrations:call shortcut.shortcut_list_stories '{"project_public_id":1,"includes_description":true}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_stories '{"project_public_id":1,"includes_description":true}' --json

`shortcut.shortcut_list_repositories`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_repositories '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_repositories '{}' --json

`shortcut.shortcut_get_repository`

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

Read read

Parameters: repo_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_repository '{"repo_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_repository '{"repo_public_id":1}' --json

`shortcut.shortcut_search`

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

Read read

Parameters: query, page_size, detail, next, entity_types

Generic call

kosmo integrations:call shortcut.shortcut_search '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

Shortcut

kosmo integrations:shortcut shortcut_search '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

`shortcut.shortcut_search_documents`

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

Read read

Parameters: title, archived, created_by_me, followed_by_me, page_size, next

Generic call

kosmo integrations:call shortcut.shortcut_search_documents '{"title":"example_title","archived":true,"created_by_me":true,"followed_by_me":true,"page_size":1,"next":"example_next"}' --json

Shortcut

kosmo integrations:shortcut shortcut_search_documents '{"title":"example_title","archived":true,"created_by_me":true,"followed_by_me":true,"page_size":1,"next":"example_next"}' --json

`shortcut.shortcut_search_epics`

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

Read read

Parameters: query, page_size, detail, next, entity_types

Generic call

kosmo integrations:call shortcut.shortcut_search_epics '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

Shortcut

kosmo integrations:shortcut shortcut_search_epics '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

`shortcut.shortcut_search_iterations`

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

Read read

Parameters: query, page_size, detail, next, entity_types

Generic call

kosmo integrations:call shortcut.shortcut_search_iterations '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

Shortcut

kosmo integrations:shortcut shortcut_search_iterations '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

`shortcut.shortcut_search_milestones`

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

Read read

Parameters: query, page_size, detail, next, entity_types

Generic call

kosmo integrations:call shortcut.shortcut_search_milestones '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

Shortcut

kosmo integrations:shortcut shortcut_search_milestones '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

`shortcut.shortcut_search_objectives`

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

Read read

Parameters: query, page_size, detail, next, entity_types

Generic call

kosmo integrations:call shortcut.shortcut_search_objectives '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

Shortcut

kosmo integrations:shortcut shortcut_search_objectives '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

`shortcut.shortcut_search_stories`

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

Read read

Parameters: query, page_size, detail, next, entity_types

Generic call

kosmo integrations:call shortcut.shortcut_search_stories '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

Shortcut

kosmo integrations:shortcut shortcut_search_stories '{"query":"example_query","page_size":1,"detail":"example_detail","next":"example_next","entity_types":"example_entity_types"}' --json

`shortcut.shortcut_create_story`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_story '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_story '{"body":"example_body"}' --json

`shortcut.shortcut_create_multiple_stories`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_multiple_stories '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_multiple_stories '{"body":"example_body"}' --json

`shortcut.shortcut_update_multiple_stories`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_update_multiple_stories '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_multiple_stories '{"body":"example_body"}' --json

`shortcut.shortcut_delete_multiple_stories`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_delete_multiple_stories '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_multiple_stories '{"body":"example_body"}' --json

`shortcut.shortcut_create_story_from_template`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_story_from_template '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_story_from_template '{"body":"example_body"}' --json

`shortcut.shortcut_query_stories`

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

Read read

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_query_stories '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_query_stories '{"body":"example_body"}' --json

`shortcut.shortcut_get_story`

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

Read read

Parameters: story_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_story '{"story_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_story '{"story_public_id":1}' --json

`shortcut.shortcut_update_story`

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

Write write

Parameters: story_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_story '{"story_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_story '{"story_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_story`

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

Write write

Parameters: story_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_story '{"story_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_story '{"story_public_id":1}' --json

`shortcut.shortcut_list_story_comment`

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

Read read

Parameters: story_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_story_comment '{"story_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_story_comment '{"story_public_id":1}' --json

`shortcut.shortcut_create_story_comment`

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

Write write

Parameters: story_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_create_story_comment '{"story_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_story_comment '{"story_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_get_story_comment`

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

Read read

Parameters: story_public_id, comment_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_story_comment '{"story_public_id":1,"comment_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_story_comment '{"story_public_id":1,"comment_public_id":1}' --json

`shortcut.shortcut_update_story_comment`

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

Write write

Parameters: story_public_id, comment_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_story_comment '{"story_public_id":1,"comment_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_story_comment '{"story_public_id":1,"comment_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_story_comment`

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

Write write

Parameters: story_public_id, comment_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_story_comment '{"story_public_id":1,"comment_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_story_comment '{"story_public_id":1,"comment_public_id":1}' --json

`shortcut.shortcut_create_story_reaction`

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

Write write

Parameters: story_public_id, comment_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_create_story_reaction '{"story_public_id":1,"comment_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_story_reaction '{"story_public_id":1,"comment_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_story_reaction`

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

Write write

Parameters: story_public_id, comment_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_delete_story_reaction '{"story_public_id":1,"comment_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_story_reaction '{"story_public_id":1,"comment_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_unlink_comment_thread_from_slack`

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

Read read

Parameters: story_public_id, comment_public_id

Generic call

kosmo integrations:call shortcut.shortcut_unlink_comment_thread_from_slack '{"story_public_id":1,"comment_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_unlink_comment_thread_from_slack '{"story_public_id":1,"comment_public_id":1}' --json

`shortcut.shortcut_story_history`

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

Read read

Parameters: story_public_id

Generic call

kosmo integrations:call shortcut.shortcut_story_history '{"story_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_story_history '{"story_public_id":1}' --json

`shortcut.shortcut_list_story_sub_tasks`

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

Read read

Parameters: story_public_id

Generic call

kosmo integrations:call shortcut.shortcut_list_story_sub_tasks '{"story_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_story_sub_tasks '{"story_public_id":1}' --json

`shortcut.shortcut_create_task`

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

Write write

Parameters: story_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_create_task '{"story_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_task '{"story_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_get_task`

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

Read read

Parameters: story_public_id, task_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_task '{"story_public_id":1,"task_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_task '{"story_public_id":1,"task_public_id":1}' --json

`shortcut.shortcut_update_task`

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

Write write

Parameters: story_public_id, task_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_task '{"story_public_id":1,"task_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_task '{"story_public_id":1,"task_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_task`

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

Write write

Parameters: story_public_id, task_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_task '{"story_public_id":1,"task_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_task '{"story_public_id":1,"task_public_id":1}' --json

`shortcut.shortcut_create_story_link`

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

Write write

Parameters: body

Generic call

kosmo integrations:call shortcut.shortcut_create_story_link '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_create_story_link '{"body":"example_body"}' --json

`shortcut.shortcut_get_story_link`

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

Read read

Parameters: story_link_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_story_link '{"story_link_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_story_link '{"story_link_public_id":1}' --json

`shortcut.shortcut_update_story_link`

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

Write write

Parameters: story_link_public_id, body

Generic call

kosmo integrations:call shortcut.shortcut_update_story_link '{"story_link_public_id":1,"body":"example_body"}' --json

Shortcut

kosmo integrations:shortcut shortcut_update_story_link '{"story_link_public_id":1,"body":"example_body"}' --json

`shortcut.shortcut_delete_story_link`

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

Write write

Parameters: story_link_public_id

Generic call

kosmo integrations:call shortcut.shortcut_delete_story_link '{"story_link_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_delete_story_link '{"story_link_public_id":1}' --json

`shortcut.shortcut_list_workflows`

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

Read read

Parameters: none

Generic call

kosmo integrations:call shortcut.shortcut_list_workflows '{}' --json

Shortcut

kosmo integrations:shortcut shortcut_list_workflows '{}' --json

`shortcut.shortcut_get_workflow`

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

Read read

Parameters: workflow_public_id

Generic call

kosmo integrations:call shortcut.shortcut_get_workflow '{"workflow_public_id":1}' --json

Shortcut

kosmo integrations:shortcut shortcut_get_workflow '{"workflow_public_id":1}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

shortcut.shortcut_list_categories 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_categories --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_create_category 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_category --json

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

shortcut.shortcut_get_category 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_category --json

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

shortcut.shortcut_update_category 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_category --json

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.

shortcut.shortcut_delete_category 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_category --json

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

shortcut.shortcut_list_category_milestones 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_category_milestones --json

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

shortcut.shortcut_list_category_objectives 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_category_objectives --json

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

shortcut.shortcut_list_custom_fields 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_custom_fields --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_get_custom_field 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_custom_field --json

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

shortcut.shortcut_update_custom_field 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_custom_field --json

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.

shortcut.shortcut_delete_custom_field 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_custom_field --json

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

shortcut.shortcut_list_docs 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_docs --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_create_doc 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_doc --json

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

shortcut.shortcut_get_doc 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_doc --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.

shortcut.shortcut_update_doc 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_doc --json

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.

shortcut.shortcut_delete_doc 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_doc --json

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.

shortcut.shortcut_list_document_epics 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_document_epics --json

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

shortcut.shortcut_link_document_to_epic 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_link_document_to_epic --json

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.

shortcut.shortcut_unlink_document_from_epic 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_unlink_document_from_epic --json

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.

shortcut.shortcut_load_tiptap_document_json 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_load_tiptap_document_json --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.

shortcut.shortcut_list_entity_templates 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_entity_templates --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_create_entity_template 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_entity_template --json

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

shortcut.shortcut_disable_story_templates 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_disable_story_templates --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_enable_story_templates 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_enable_story_templates --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_get_entity_template 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_entity_template --json

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

shortcut.shortcut_update_entity_template 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_entity_template --json

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.

shortcut.shortcut_delete_entity_template 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_entity_template --json

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

shortcut.shortcut_get_epic_workflow 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_epic_workflow --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_list_epics 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_epics --json

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

shortcut.shortcut_create_epic 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_epic --json

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

shortcut.shortcut_list_epics_paginated 3 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_epics_paginated --json

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.

shortcut.shortcut_get_epic 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_epic --json

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

shortcut.shortcut_update_epic 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_epic --json

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.

shortcut.shortcut_delete_epic 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_epic --json

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

shortcut.shortcut_list_epic_comments 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_epic_comments --json

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

shortcut.shortcut_create_epic_comment 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_epic_comment --json

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.

shortcut.shortcut_create_epic_comment_comment 3 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_epic_comment_comment --json

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.

shortcut.shortcut_get_epic_comment 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_epic_comment --json

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.

shortcut.shortcut_update_epic_comment 3 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_epic_comment --json

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.

shortcut.shortcut_delete_epic_comment 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_epic_comment --json

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.

shortcut.shortcut_list_epic_documents 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_epic_documents --json

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

shortcut.shortcut_get_epic_health 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_epic_health --json

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

shortcut.shortcut_create_epic_health 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_epic_health --json

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.

shortcut.shortcut_list_epic_healths 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_epic_healths --json

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

shortcut.shortcut_list_epic_stories 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_epic_stories --json

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.

shortcut.shortcut_get_external_link_stories 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_external_link_stories --json

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

shortcut.shortcut_list_files 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_files --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_upload_files 5 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_upload_files --json

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.

shortcut.shortcut_get_file 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_file --json

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

shortcut.shortcut_update_file 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_file --json

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.

shortcut.shortcut_delete_file 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_file --json

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

shortcut.shortcut_list_groups 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_groups --json

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

shortcut.shortcut_create_group 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_group --json

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

shortcut.shortcut_get_group 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_group --json

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

shortcut.shortcut_update_group 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_group --json

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.

shortcut.shortcut_list_group_stories 3 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_group_stories --json

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)

shortcut.shortcut_update_health 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_health --json

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.

shortcut.shortcut_create_generic_integration 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_generic_integration --json

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

shortcut.shortcut_get_generic_integration 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_generic_integration --json

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

shortcut.shortcut_delete_generic_integration 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_generic_integration --json

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

shortcut.shortcut_list_iterations 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_iterations --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_create_iteration 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_iteration --json

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

shortcut.shortcut_disable_iterations 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_disable_iterations --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_enable_iterations 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_enable_iterations --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_get_iteration 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_iteration --json

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

shortcut.shortcut_update_iteration 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_iteration --json

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.

shortcut.shortcut_delete_iteration 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_iteration --json

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

shortcut.shortcut_list_iteration_stories 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_iteration_stories --json

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.

shortcut.shortcut_get_key_result 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_key_result --json

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

shortcut.shortcut_update_key_result 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_key_result --json

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.

shortcut.shortcut_list_labels 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_labels --json

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

shortcut.shortcut_create_label 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_label --json

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

shortcut.shortcut_get_label 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_label --json

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

shortcut.shortcut_update_label 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_label --json

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.

shortcut.shortcut_delete_label 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_label --json

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

shortcut.shortcut_list_label_epics 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_label_epics --json

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

shortcut.shortcut_list_label_stories 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_label_stories --json

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.

shortcut.shortcut_list_linked_files 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_linked_files --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_create_linked_file 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_linked_file --json

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

shortcut.shortcut_get_linked_file 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_linked_file --json

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

shortcut.shortcut_update_linked_file 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_linked_file --json

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.

shortcut.shortcut_delete_linked_file 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_linked_file --json

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

shortcut.shortcut_get_current_member_info 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_current_member_info --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_list_members 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_members --json

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.

shortcut.shortcut_get_member 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_member --json

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.

shortcut.shortcut_list_milestones 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_milestones --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_create_milestone 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_milestone --json

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

shortcut.shortcut_get_milestone 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_milestone --json

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

shortcut.shortcut_update_milestone 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_milestone --json

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.

shortcut.shortcut_delete_milestone 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_milestone --json

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

shortcut.shortcut_list_milestone_epics 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_milestone_epics --json

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

shortcut.shortcut_list_objectives 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_objectives --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_create_objective 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_objective --json

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

shortcut.shortcut_get_objective 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_objective --json

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

shortcut.shortcut_update_objective 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_objective --json

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.

shortcut.shortcut_delete_objective 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_objective --json

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

shortcut.shortcut_list_objective_epics 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_objective_epics --json

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

shortcut.shortcut_get_objective_health 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_objective_health --json

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

shortcut.shortcut_create_objective_health 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_objective_health --json

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.

shortcut.shortcut_list_objective_healths 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_objective_healths --json

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

shortcut.shortcut_list_projects 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_projects --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_create_project 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_project --json

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

shortcut.shortcut_get_project 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_project --json

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

shortcut.shortcut_update_project 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_project --json

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.

shortcut.shortcut_delete_project 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_project --json

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

shortcut.shortcut_list_stories 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_stories --json

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.

shortcut.shortcut_list_repositories 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_repositories --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_get_repository 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_repository --json

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

shortcut.shortcut_search 5 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_search --json

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.

shortcut.shortcut_search_documents 6 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_search_documents --json

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.

shortcut.shortcut_search_epics 5 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_search_epics --json

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.

shortcut.shortcut_search_iterations 5 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_search_iterations --json

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.

shortcut.shortcut_search_milestones 5 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_search_milestones --json

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.

shortcut.shortcut_search_objectives 5 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_search_objectives --json

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.

shortcut.shortcut_search_stories 5 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_search_stories --json

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.

shortcut.shortcut_create_story 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_story --json

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

shortcut.shortcut_create_multiple_stories 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_multiple_stories --json

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

shortcut.shortcut_update_multiple_stories 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_multiple_stories --json

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

shortcut.shortcut_delete_multiple_stories 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_multiple_stories --json

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

shortcut.shortcut_create_story_from_template 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_story_from_template --json

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.

shortcut.shortcut_query_stories 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_query_stories --json

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

shortcut.shortcut_get_story 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_story --json

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

shortcut.shortcut_update_story 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_story --json

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.

shortcut.shortcut_delete_story 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_story --json

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

shortcut.shortcut_list_story_comment 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_story_comment --json

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

shortcut.shortcut_create_story_comment 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_story_comment --json

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.

shortcut.shortcut_get_story_comment 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_story_comment --json

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.

shortcut.shortcut_update_story_comment 3 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_story_comment --json

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.

shortcut.shortcut_delete_story_comment 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_story_comment --json

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.

shortcut.shortcut_create_story_reaction 3 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_story_reaction --json

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.

shortcut.shortcut_delete_story_reaction 3 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_story_reaction --json

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.

shortcut.shortcut_unlink_comment_thread_from_slack 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_unlink_comment_thread_from_slack --json

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.

shortcut.shortcut_story_history 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_story_history --json

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

shortcut.shortcut_list_story_sub_tasks 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_story_sub_tasks --json

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

shortcut.shortcut_create_task 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_task --json

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.

shortcut.shortcut_get_task 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_task --json

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.

shortcut.shortcut_update_task 3 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_task --json

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.

shortcut.shortcut_delete_task 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_task --json

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.

shortcut.shortcut_create_story_link 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_create_story_link --json

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

shortcut.shortcut_get_story_link 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_story_link --json

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

shortcut.shortcut_update_story_link 2 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_update_story_link --json

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.

shortcut.shortcut_delete_story_link 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_delete_story_link --json

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

shortcut.shortcut_list_workflows 0 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_list_workflows --json

Parameter	Type	Required	Description
No parameters.

shortcut.shortcut_get_workflow 1 parameters

Schema command

kosmo integrations:schema shortcut.shortcut_get_workflow --json

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

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.