/shortcut-epics | Type: Application | PCID required: Yes
Tools
shortcut_epics_create_epic
Create Epic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
completed_at_override | string | No | — | A manual override for the time/date the Epic was completed. |
converted_from_story_id | integer | No | — | The ID of the Story that was converted to an Epic. |
created_at | string | No | — | Defaults to the time/date it is created but can be set to reflect another date. |
deadline | string | No | — | The Epic’s deadline. |
description | string | No | — | The Epic’s description. |
epic_state_id | integer | No | — | The ID of the Epic State. |
external_id | string | No | — | This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. |
follower_ids | string[] | No | — | An array of UUIDs for any Members you want to add as Followers on this new Epic. |
group_id | string | No | — | Deprecated The ID of the group to associate with the epic. Use group_ids. |
group_ids | string[] | No | — | An array of UUIDS for Groups to which this Epic is related. |
labels | object[] | No | — | An array of Labels attached to the Epic. |
milestone_id | integer | No | — | Deprecated The ID of the Milestone this Epic is related to. Use objective_ids. |
name | string | Yes | — | The Epic’s name. |
objective_ids | integer[] | No | — | An array of IDs for Objectives to which this Epic is related. |
owner_ids | string[] | No | — | An array of UUIDs for any members you want to add as Owners on this new Epic. |
planned_start_date | string | No | — | The Epic’s planned start date. |
requested_by_id | string | No | — | The ID of the member that requested the epic. |
started_at_override | string | No | — | A manual override for the time/date the Epic was started. |
state | string | No | — | Deprecated The Epic’s state (to do, in progress, or done); will be ignored when epic_state_id is set. |
updated_at | string | No | — | Defaults to the time/date it is created but can be set to reflect another date. |
shortcut_epics_create_epic_comment
Create Epic Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The ID of the associated Epic. |
author_id | string | No | — | The Member ID of the Comment’s author. Defaults to the user identified by the API token. |
created_at | string | No | — | Defaults to the time/date the comment is created, but can be set to reflect another date. |
external_id | string | No | — | This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here. |
text | string | Yes | — | The comment text. |
updated_at | string | No | — | Defaults to the time/date the comment is last updated, but can be set to reflect another date. |
shortcut_epics_create_epic_comment_comment
Create Epic Comment Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The ID of the associated Epic. |
comment-public-id | integer | Yes | — | The ID of the parent Epic Comment. |
author_id | string | No | — | The Member ID of the Comment’s author. Defaults to the user identified by the API token. |
created_at | string | No | — | Defaults to the time/date the comment is created, but can be set to reflect another date. |
external_id | string | No | — | This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here. |
text | string | Yes | — | The comment text. |
updated_at | string | No | — | Defaults to the time/date the comment is last updated, but can be set to reflect another date. |
shortcut_epics_create_epic_health
Create Epic Health Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The unique ID of the Epic. |
status | string | Yes | — | The health status of the Epic. |
text | string | No | — | The description of the Health status. |
shortcut_epics_create_objective
Create Objective Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categories | object[] | No | — | An array of IDs of Categories attached to the Objective. |
completed_at_override | string | No | — | A manual override for the time/date the Objective was completed. |
description | string | No | — | The Objective’s description. |
name | string | Yes | — | The name of the Objective. |
started_at_override | string | No | — | A manual override for the time/date the Objective was started. |
state | string | No | — | The workflow state that the Objective is in. |
shortcut_epics_create_objective_health
Create Objective Health Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
objective-public-id | integer | Yes | — | The unique ID of the Objective. |
status | string | Yes | — | The health status of the Objective. |
text | string | No | — | The description of the Health status. |
shortcut_epics_delete_epic
Delete Epic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The unique ID of the Epic. |
shortcut_epics_delete_epic_comment
Delete Epic Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The ID of the associated Epic. |
comment-public-id | integer | Yes | — | The ID of the Comment. |
shortcut_epics_delete_objective
Delete Objective Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
objective-public-id | integer | Yes | — | The ID of the Objective. |
shortcut_epics_get_epic
Get Epic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The unique ID of the Epic. |
shortcut_epics_get_epic_comment
Get Epic Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The ID of the associated Epic. |
comment-public-id | integer | Yes | — | The ID of the Comment. |
shortcut_epics_get_epic_health
Get Epic Health Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The unique ID of the Epic. |
shortcut_epics_get_epic_workflow
Get Epic Workflowshortcut_epics_get_key_result
Get Key Result Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key-result-public-id | string | Yes | — | The ID of the Key Result. |
shortcut_epics_get_objective
Get Objective Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
objective-public-id | integer | Yes | — | The ID of the Objective. |
shortcut_epics_get_objective_health
Get Objective Health Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
objective-public-id | integer | Yes | — | The unique ID of the Objective. |
shortcut_epics_list_epic_comments
List Epic Comments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The unique ID of the Epic. |
shortcut_epics_list_epic_documents
List Epic Documents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The unique ID of the Epic. |
shortcut_epics_list_epic_healths
List Epic Healths Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The unique ID of the Epic. |
shortcut_epics_list_epic_stories
List Epic Stories Parameters:| Parameter | Type | Required | Default | 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_epics_list_epics
List Epics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includes_description | boolean | No | — | A true/false boolean indicating whether to return Epics with their descriptions. |
shortcut_epics_list_epics_paginated
List Epics Paginated Parameters:| Parameter | Type | Required | Default | 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_epics_list_objective_epics
List Objective Epics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
objective-public-id | integer | Yes | — | The ID of the Objective. |
shortcut_epics_list_objective_healths
List Objective Healths Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
objective-public-id | integer | Yes | — | The unique ID of the Objective. |
shortcut_epics_list_objectives
List Objectivesshortcut_epics_update_epic
Update Epic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The unique ID of the Epic. |
after_id | integer | No | — | The ID of the Epic we want to move this Epic after. |
archived | boolean | No | — | A true/false boolean indicating whether the Epic is in archived state. |
before_id | integer | No | — | The ID of the Epic we want to move this Epic before. |
completed_at_override | string | No | — | A manual override for the time/date the Epic was completed. |
deadline | string | No | — | The Epic’s deadline. |
description | string | No | — | The Epic’s description. |
epic_state_id | integer | No | — | The ID of the Epic State. |
external_id | string | No | — | This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. |
follower_ids | string[] | No | — | An array of UUIDs for any Members you want to add as Followers on this Epic. |
group_id | string | No | — | Deprecated The ID of the group to associate with the epic. Use group_ids. |
group_ids | string[] | No | — | An array of UUIDS for Groups to which this Epic is related. |
labels | object[] | No | — | An array of Labels attached to the Epic. |
milestone_id | integer | No | — | Deprecated The ID of the Milestone this Epic is related to. Use objective_ids. |
name | string | No | — | The Epic’s name. |
objective_ids | integer[] | No | — | An array of IDs for Objectives to which this Epic is related. |
owner_ids | string[] | No | — | An array of UUIDs for any members you want to add as Owners on this Epic. |
planned_start_date | string | No | — | The Epic’s planned start date. |
requested_by_id | string | No | — | The ID of the member that requested the epic. |
started_at_override | string | No | — | A manual override for the time/date the Epic was started. |
state | string | No | — | Deprecated The Epic’s state (to do, in progress, or done); will be ignored when epic_state_id is set. |
shortcut_epics_update_epic_comment
Update Epic Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
epic-public-id | integer | Yes | — | The ID of the associated Epic. |
comment-public-id | integer | Yes | — | The ID of the Comment. |
text | string | Yes | — | The updated comment text. |
shortcut_epics_update_key_result
Update Key Result Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key-result-public-id | string | Yes | — | The ID of the Key Result. |
initial_observed_value | object | No | — | The starting value of the Key Result. |
name | string | No | — | The name of the Key Result. |
observed_value | object | No | — | The starting value of the Key Result. |
target_value | object | No | — | The starting value of the Key Result. |
shortcut_epics_update_objective
Update Objective Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
objective-public-id | integer | Yes | — | The ID of the Objective. |
after_id | integer | No | — | The ID of the Objective we want to move this Objective after. |
archived | boolean | No | — | A boolean indicating whether the Objective is archived or not |
before_id | integer | No | — | The ID of the Objective we want to move this Objective before. |
categories | object[] | No | — | An array of IDs of Categories attached to the Objective. |
completed_at_override | string | No | — | A manual override for the time/date the Objective was completed. |
description | string | No | — | The Objective’s description. |
name | string | No | — | The name of the Objective. |
started_at_override | string | No | — | A manual override for the time/date the Objective was started. |
state | string | No | — | The workflow state that the Objective is in. |

