> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# shortcut-epics
> Shortcut Epics - manage epics, milestones, objectives, key results, and epic workflows
**Server path:** `/shortcut-epics` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------- | --------------------------- |
| [`shortcut_epics_create_epic`](#shortcut_epics_create_epic) | Create Epic |
| [`shortcut_epics_create_epic_comment`](#shortcut_epics_create_epic_comment) | Create Epic Comment |
| [`shortcut_epics_create_epic_comment_comment`](#shortcut_epics_create_epic_comment_comment) | Create Epic Comment Comment |
| [`shortcut_epics_create_epic_health`](#shortcut_epics_create_epic_health) | Create Epic Health |
| [`shortcut_epics_create_objective`](#shortcut_epics_create_objective) | Create Objective |
| [`shortcut_epics_create_objective_health`](#shortcut_epics_create_objective_health) | Create Objective Health |
| [`shortcut_epics_delete_epic`](#shortcut_epics_delete_epic) | Delete Epic |
| [`shortcut_epics_delete_epic_comment`](#shortcut_epics_delete_epic_comment) | Delete Epic Comment |
| [`shortcut_epics_delete_objective`](#shortcut_epics_delete_objective) | Delete Objective |
| [`shortcut_epics_get_epic`](#shortcut_epics_get_epic) | Get Epic |
| [`shortcut_epics_get_epic_comment`](#shortcut_epics_get_epic_comment) | Get Epic Comment |
| [`shortcut_epics_get_epic_health`](#shortcut_epics_get_epic_health) | Get Epic Health |
| [`shortcut_epics_get_epic_workflow`](#shortcut_epics_get_epic_workflow) | Get Epic Workflow |
| [`shortcut_epics_get_key_result`](#shortcut_epics_get_key_result) | Get Key Result |
| [`shortcut_epics_get_objective`](#shortcut_epics_get_objective) | Get Objective |
| [`shortcut_epics_get_objective_health`](#shortcut_epics_get_objective_health) | Get Objective Health |
| [`shortcut_epics_list_epic_comments`](#shortcut_epics_list_epic_comments) | List Epic Comments |
| [`shortcut_epics_list_epic_documents`](#shortcut_epics_list_epic_documents) | List Epic Documents |
| [`shortcut_epics_list_epic_healths`](#shortcut_epics_list_epic_healths) | List Epic Healths |
| [`shortcut_epics_list_epic_stories`](#shortcut_epics_list_epic_stories) | List Epic Stories |
| [`shortcut_epics_list_epics`](#shortcut_epics_list_epics) | List Epics |
| [`shortcut_epics_list_epics_paginated`](#shortcut_epics_list_epics_paginated) | List Epics Paginated |
| [`shortcut_epics_list_objective_epics`](#shortcut_epics_list_objective_epics) | List Objective Epics |
| [`shortcut_epics_list_objective_healths`](#shortcut_epics_list_objective_healths) | List Objective Healths |
| [`shortcut_epics_list_objectives`](#shortcut_epics_list_objectives) | List Objectives |
| [`shortcut_epics_update_epic`](#shortcut_epics_update_epic) | Update Epic |
| [`shortcut_epics_update_epic_comment`](#shortcut_epics_update_epic_comment) | Update Epic Comment |
| [`shortcut_epics_update_key_result`](#shortcut_epics_update_key_result) | Update Key Result |
| [`shortcut_epics_update_objective`](#shortcut_epics_update_objective) | Update Objective |
***
## 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 | null | 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 | null | 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 | null | 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 | null | 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 | null | 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. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"completed_at_override": {
"type": "string",
"description": "A manual override for the time/date the Epic was completed."
},
"converted_from_story_id": {
"type": [
"integer",
"null"
],
"description": "The ID of the Story that was converted to an Epic."
},
"created_at": {
"type": "string",
"description": "Defaults to the time/date it is created but can be set to reflect another date."
},
"deadline": {
"type": [
"string",
"null"
],
"description": "The Epic's deadline."
},
"description": {
"type": "string",
"description": "The Epic's description."
},
"epic_state_id": {
"type": "integer",
"description": "The ID of the Epic State."
},
"external_id": {
"type": "string",
"description": "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": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "An array of UUIDs for any Members you want to add as Followers on this new Epic."
},
"group_id": {
"type": [
"string",
"null"
],
"description": "`Deprecated` The ID of the group to associate with the epic. Use `group_ids`."
},
"group_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "An array of UUIDS for Groups to which this Epic is related."
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new Label."
},
"description": {
"type": "string",
"description": "The description of the new Label."
},
"color": {
"type": "string",
"format": "css-color",
"description": "The hex color to be displayed with the Label (for example, \"#ff0000\")."
},
"external_id": {
"type": "string",
"description": "This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here."
}
},
"required": [
"name"
]
},
"description": "An array of Labels attached to the Epic."
},
"milestone_id": {
"type": [
"integer",
"null"
],
"description": "`Deprecated` The ID of the Milestone this Epic is related to. Use `objective_ids`."
},
"name": {
"type": "string",
"description": "The Epic's name."
},
"objective_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "An array of IDs for Objectives to which this Epic is related."
},
"owner_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "An array of UUIDs for any members you want to add as Owners on this new Epic."
},
"planned_start_date": {
"type": [
"string",
"null"
],
"description": "The Epic's planned start date."
},
"requested_by_id": {
"type": "string",
"description": "The ID of the member that requested the epic."
},
"started_at_override": {
"type": "string",
"description": "A manual override for the time/date the Epic was started."
},
"state": {
"type": "string",
"description": "`Deprecated` The Epic's state (to do, in progress, or done); will be ignored when `epic_state_id` is set.",
"enum": [
"in progress",
"to do",
"done"
]
},
"updated_at": {
"type": "string",
"description": "Defaults to the time/date it is created but can be set to reflect another date."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The ID of the associated Epic."
},
"author_id": {
"type": "string",
"description": "The Member ID of the Comment's author. Defaults to the user identified by the API token."
},
"created_at": {
"type": "string",
"description": "Defaults to the time/date the comment is created, but can be set to reflect another date."
},
"external_id": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The comment text."
},
"updated_at": {
"type": "string",
"description": "Defaults to the time/date the comment is last updated, but can be set to reflect another date."
}
},
"required": [
"PCID",
"epic-public-id",
"text"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The ID of the associated Epic."
},
"comment-public-id": {
"type": "integer",
"description": "The ID of the parent Epic Comment."
},
"author_id": {
"type": "string",
"description": "The Member ID of the Comment's author. Defaults to the user identified by the API token."
},
"created_at": {
"type": "string",
"description": "Defaults to the time/date the comment is created, but can be set to reflect another date."
},
"external_id": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The comment text."
},
"updated_at": {
"type": "string",
"description": "Defaults to the time/date the comment is last updated, but can be set to reflect another date."
}
},
"required": [
"PCID",
"epic-public-id",
"comment-public-id",
"text"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The unique ID of the Epic."
},
"status": {
"type": "string",
"description": "The health status of the Epic.",
"enum": [
"At Risk",
"On Track",
"Off Track",
"No Health"
]
},
"text": {
"type": "string",
"description": "The description of the Health status."
}
},
"required": [
"PCID",
"epic-public-id",
"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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new Category."
},
"color": {
"type": "string",
"format": "css-color",
"description": "The hex color to be displayed with the Category (for example, \"#ff0000\")."
},
"external_id": {
"type": "string",
"description": "This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here."
}
},
"required": [
"name"
]
},
"description": "An array of IDs of Categories attached to the Objective."
},
"completed_at_override": {
"type": "string",
"description": "A manual override for the time/date the Objective was completed."
},
"description": {
"type": "string",
"description": "The Objective's description."
},
"name": {
"type": "string",
"description": "The name of the Objective."
},
"started_at_override": {
"type": "string",
"description": "A manual override for the time/date the Objective was started."
},
"state": {
"type": "string",
"description": "The workflow state that the Objective is in.",
"enum": [
"in progress",
"to do",
"done"
]
}
},
"required": [
"PCID",
"name"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"objective-public-id": {
"type": "integer",
"description": "The unique ID of the Objective."
},
"status": {
"type": "string",
"description": "The health status of the Objective.",
"enum": [
"At Risk",
"On Track",
"Off Track",
"No Health"
]
},
"text": {
"type": "string",
"description": "The description of the Health status."
}
},
"required": [
"PCID",
"objective-public-id",
"status"
]
}
```
***
## shortcut\_epics\_delete\_epic
Delete Epic
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | -------------------------- |
| `epic-public-id` | integer | Yes | — | The unique ID of the Epic. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The unique ID of the Epic."
}
},
"required": [
"PCID",
"epic-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The ID of the associated Epic."
},
"comment-public-id": {
"type": "integer",
"description": "The ID of the Comment."
}
},
"required": [
"PCID",
"epic-public-id",
"comment-public-id"
]
}
```
***
## shortcut\_epics\_delete\_objective
Delete Objective
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ------------------------ |
| `objective-public-id` | integer | Yes | — | The ID of the Objective. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"objective-public-id": {
"type": "integer",
"description": "The ID of the Objective."
}
},
"required": [
"PCID",
"objective-public-id"
]
}
```
***
## shortcut\_epics\_get\_epic
Get Epic
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | -------------------------- |
| `epic-public-id` | integer | Yes | — | The unique ID of the Epic. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The unique ID of the Epic."
}
},
"required": [
"PCID",
"epic-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The ID of the associated Epic."
},
"comment-public-id": {
"type": "integer",
"description": "The ID of the Comment."
}
},
"required": [
"PCID",
"epic-public-id",
"comment-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The unique ID of the Epic."
}
},
"required": [
"PCID",
"epic-public-id"
]
}
```
***
## shortcut\_epics\_get\_epic\_workflow
Get Epic Workflow
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## shortcut\_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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key-result-public-id": {
"type": "string",
"description": "The ID of the Key Result."
}
},
"required": [
"PCID",
"key-result-public-id"
]
}
```
***
## shortcut\_epics\_get\_objective
Get Objective
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ------------------------ |
| `objective-public-id` | integer | Yes | — | The ID of the Objective. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"objective-public-id": {
"type": "integer",
"description": "The ID of the Objective."
}
},
"required": [
"PCID",
"objective-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"objective-public-id": {
"type": "integer",
"description": "The unique ID of the Objective."
}
},
"required": [
"PCID",
"objective-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The unique ID of the Epic."
}
},
"required": [
"PCID",
"epic-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The unique ID of the Epic."
}
},
"required": [
"PCID",
"epic-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The unique ID of the Epic."
}
},
"required": [
"PCID",
"epic-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The unique ID of the Epic."
},
"includes_description": {
"type": "boolean",
"description": "A true/false boolean indicating whether to return Stories with their descriptions."
}
},
"required": [
"PCID",
"epic-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includes_description": {
"type": "boolean",
"description": "A true/false boolean indicating whether to return Epics with their descriptions."
}
},
"required": [
"PCID"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includes_description": {
"type": "boolean",
"description": "A true/false boolean indicating whether to return Epics with their descriptions."
},
"page": {
"type": "integer",
"description": "The page number to return, starting with 1. Defaults to 1."
},
"page_size": {
"type": "integer",
"description": "The number of Epics to return per page. Minimum 1, maximum 250, default 10."
}
},
"required": [
"PCID"
]
}
```
***
## shortcut\_epics\_list\_objective\_epics
List Objective Epics
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ------------------------ |
| `objective-public-id` | integer | Yes | — | The ID of the Objective. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"objective-public-id": {
"type": "integer",
"description": "The ID of the Objective."
}
},
"required": [
"PCID",
"objective-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"objective-public-id": {
"type": "integer",
"description": "The unique ID of the Objective."
}
},
"required": [
"PCID",
"objective-public-id"
]
}
```
***
## shortcut\_epics\_list\_objectives
List Objectives
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## shortcut\_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 | null | No | — | A manual override for the time/date the Epic was completed. |
| `deadline` | string | null | 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 | null | 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 | null | 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 | null | 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 | null | 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. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The unique ID of the Epic."
},
"after_id": {
"type": "integer",
"description": "The ID of the Epic we want to move this Epic after."
},
"archived": {
"type": "boolean",
"description": "A true/false boolean indicating whether the Epic is in archived state."
},
"before_id": {
"type": "integer",
"description": "The ID of the Epic we want to move this Epic before."
},
"completed_at_override": {
"type": [
"string",
"null"
],
"description": "A manual override for the time/date the Epic was completed."
},
"deadline": {
"type": [
"string",
"null"
],
"description": "The Epic's deadline."
},
"description": {
"type": "string",
"description": "The Epic's description."
},
"epic_state_id": {
"type": "integer",
"description": "The ID of the Epic State."
},
"external_id": {
"type": "string",
"description": "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": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "An array of UUIDs for any Members you want to add as Followers on this Epic."
},
"group_id": {
"type": [
"string",
"null"
],
"description": "`Deprecated` The ID of the group to associate with the epic. Use `group_ids`."
},
"group_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "An array of UUIDS for Groups to which this Epic is related."
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new Label."
},
"description": {
"type": "string",
"description": "The description of the new Label."
},
"color": {
"type": "string",
"format": "css-color",
"description": "The hex color to be displayed with the Label (for example, \"#ff0000\")."
},
"external_id": {
"type": "string",
"description": "This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here."
}
},
"required": [
"name"
]
},
"description": "An array of Labels attached to the Epic."
},
"milestone_id": {
"type": [
"integer",
"null"
],
"description": "`Deprecated` The ID of the Milestone this Epic is related to. Use `objective_ids`."
},
"name": {
"type": "string",
"description": "The Epic's name."
},
"objective_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "An array of IDs for Objectives to which this Epic is related."
},
"owner_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "An array of UUIDs for any members you want to add as Owners on this Epic."
},
"planned_start_date": {
"type": [
"string",
"null"
],
"description": "The Epic's planned start date."
},
"requested_by_id": {
"type": "string",
"description": "The ID of the member that requested the epic."
},
"started_at_override": {
"type": [
"string",
"null"
],
"description": "A manual override for the time/date the Epic was started."
},
"state": {
"type": "string",
"description": "`Deprecated` The Epic's state (to do, in progress, or done); will be ignored when `epic_state_id` is set.",
"enum": [
"in progress",
"to do",
"done"
]
}
},
"required": [
"PCID",
"epic-public-id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"epic-public-id": {
"type": "integer",
"description": "The ID of the associated Epic."
},
"comment-public-id": {
"type": "integer",
"description": "The ID of the Comment."
},
"text": {
"type": "string",
"description": "The updated comment text."
}
},
"required": [
"PCID",
"epic-public-id",
"comment-public-id",
"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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key-result-public-id": {
"type": "string",
"description": "The ID of the Key Result."
},
"initial_observed_value": {
"type": "object",
"description": "The starting value of the Key Result.",
"properties": {
"numeric_value": {
"type": "string",
"description": "The numeric value, as a decimal string. No more than two decimal places are allowed."
},
"boolean_value": {
"type": "boolean",
"description": "The boolean value."
}
}
},
"name": {
"type": "string",
"description": "The name of the Key Result."
},
"observed_value": {
"type": "object",
"description": "The starting value of the Key Result.",
"properties": {
"numeric_value": {
"type": "string",
"description": "The numeric value, as a decimal string. No more than two decimal places are allowed."
},
"boolean_value": {
"type": "boolean",
"description": "The boolean value."
}
}
},
"target_value": {
"type": "object",
"description": "The starting value of the Key Result.",
"properties": {
"numeric_value": {
"type": "string",
"description": "The numeric value, as a decimal string. No more than two decimal places are allowed."
},
"boolean_value": {
"type": "boolean",
"description": "The boolean value."
}
}
}
},
"required": [
"PCID",
"key-result-public-id"
]
}
```
***
## 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 | null | 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 | null | No | — | A manual override for the time/date the Objective was started. |
| `state` | string | No | — | The workflow state that the Objective is in. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"objective-public-id": {
"type": "integer",
"description": "The ID of the Objective."
},
"after_id": {
"type": "integer",
"description": "The ID of the Objective we want to move this Objective after."
},
"archived": {
"type": "boolean",
"description": "A boolean indicating whether the Objective is archived or not"
},
"before_id": {
"type": "integer",
"description": "The ID of the Objective we want to move this Objective before."
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new Category."
},
"color": {
"type": "string",
"format": "css-color",
"description": "The hex color to be displayed with the Category (for example, \"#ff0000\")."
},
"external_id": {
"type": "string",
"description": "This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here."
}
},
"required": [
"name"
]
},
"description": "An array of IDs of Categories attached to the Objective."
},
"completed_at_override": {
"type": [
"string",
"null"
],
"description": "A manual override for the time/date the Objective was completed."
},
"description": {
"type": "string",
"description": "The Objective's description."
},
"name": {
"type": "string",
"description": "The name of the Objective."
},
"started_at_override": {
"type": [
"string",
"null"
],
"description": "A manual override for the time/date the Objective was started."
},
"state": {
"type": "string",
"description": "The workflow state that the Objective is in.",
"enum": [
"in progress",
"to do",
"done"
]
}
},
"required": [
"PCID",
"objective-public-id"
]
}
```