> ## 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-projects > Shortcut Projects - manage projects, iterations, categories, labels, workflows, custom fields, and groups **Server path:** `/shortcut-projects` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------- | ------------------------ | | [`shortcut_projects_create_category`](#shortcut_projects_create_category) | Create Category | | [`shortcut_projects_create_group`](#shortcut_projects_create_group) | Create Group | | [`shortcut_projects_create_iteration`](#shortcut_projects_create_iteration) | Create Iteration | | [`shortcut_projects_create_label`](#shortcut_projects_create_label) | Create Label | | [`shortcut_projects_create_project`](#shortcut_projects_create_project) | Create Project | | [`shortcut_projects_delete_category`](#shortcut_projects_delete_category) | Delete Category | | [`shortcut_projects_delete_custom_field`](#shortcut_projects_delete_custom_field) | Delete Custom Field | | [`shortcut_projects_delete_iteration`](#shortcut_projects_delete_iteration) | Delete Iteration | | [`shortcut_projects_delete_label`](#shortcut_projects_delete_label) | Delete Label | | [`shortcut_projects_delete_project`](#shortcut_projects_delete_project) | Delete Project | | [`shortcut_projects_disable_iterations`](#shortcut_projects_disable_iterations) | Disable Iterations | | [`shortcut_projects_enable_iterations`](#shortcut_projects_enable_iterations) | Enable Iterations | | [`shortcut_projects_get_category`](#shortcut_projects_get_category) | Get Category | | [`shortcut_projects_get_custom_field`](#shortcut_projects_get_custom_field) | Get Custom Field | | [`shortcut_projects_get_group`](#shortcut_projects_get_group) | Get Group | | [`shortcut_projects_get_iteration`](#shortcut_projects_get_iteration) | Get Iteration | | [`shortcut_projects_get_label`](#shortcut_projects_get_label) | Get Label | | [`shortcut_projects_get_project`](#shortcut_projects_get_project) | Get Project | | [`shortcut_projects_get_workflow`](#shortcut_projects_get_workflow) | Get Workflow | | [`shortcut_projects_list_categories`](#shortcut_projects_list_categories) | List Categories | | [`shortcut_projects_list_category_milestones`](#shortcut_projects_list_category_milestones) | List Category Milestones | | [`shortcut_projects_list_category_objectives`](#shortcut_projects_list_category_objectives) | List Category Objectives | | [`shortcut_projects_list_custom_fields`](#shortcut_projects_list_custom_fields) | List Custom Fields | | [`shortcut_projects_list_group_stories`](#shortcut_projects_list_group_stories) | List Group Stories | | [`shortcut_projects_list_groups`](#shortcut_projects_list_groups) | List Groups | | [`shortcut_projects_list_iteration_stories`](#shortcut_projects_list_iteration_stories) | List Iteration Stories | | [`shortcut_projects_list_iterations`](#shortcut_projects_list_iterations) | List Iterations | | [`shortcut_projects_list_label_epics`](#shortcut_projects_list_label_epics) | List Label Epics | | [`shortcut_projects_list_label_stories`](#shortcut_projects_list_label_stories) | List Label Stories | | [`shortcut_projects_list_labels`](#shortcut_projects_list_labels) | List Labels | | [`shortcut_projects_list_projects`](#shortcut_projects_list_projects) | List Projects | | [`shortcut_projects_list_stories`](#shortcut_projects_list_stories) | List Stories | | [`shortcut_projects_list_workflows`](#shortcut_projects_list_workflows) | List Workflows | | [`shortcut_projects_update_category`](#shortcut_projects_update_category) | Update Category | | [`shortcut_projects_update_custom_field`](#shortcut_projects_update_custom_field) | Update Custom Field | | [`shortcut_projects_update_group`](#shortcut_projects_update_group) | Update Group | | [`shortcut_projects_update_iteration`](#shortcut_projects_update_iteration) | Update Iteration | | [`shortcut_projects_update_label`](#shortcut_projects_update_label) | Update Label | | [`shortcut_projects_update_project`](#shortcut_projects_update_project) | Update Project | *** ## shortcut\_projects\_create\_category Create Category **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `color` | string | No | — | The hex color to be displayed with the Category (for example, "#ff0000"). | | `external_id` | string | No | — | 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. | | `name` | string | Yes | — | The name of the new Category. | | `type` | string | No | — | The type of entity this Category is associated with; currently Milestone or Objective is the only type of Category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "color": { "type": "string", "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." }, "name": { "type": "string", "description": "The name of the new Category." }, "type": { "type": "string", "description": "The type of entity this Category is associated with; currently Milestone or Objective is the only type of Category." } }, "required": [ "PCID", "name" ] } ``` *** ## shortcut\_projects\_create\_group Create Group **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ---------- | -------- | ------- | ---------------------------------------------------------- | | `color` | string | No | — | The color you wish to use for the Group in the system. | | `color_key` | string | No | — | The color key you wish to use for the Group in the system. | | `description` | string | No | — | The description of the Group. | | `display_icon_id` | string | No | — | The Icon id for the avatar of this Group. | | `member_ids` | string\[] | No | — | The Member ids to add to this Group. | | `mention_name` | string | Yes | — | The mention name of this Group. | | `name` | string | Yes | — | The name of this Group. | | `workflow_ids` | integer\[] | No | — | The Workflow ids to add to the Group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "color": { "type": "string", "description": "The color you wish to use for the Group in the system." }, "color_key": { "type": "string", "description": "The color key you wish to use for the Group in the system.", "enum": [ "blue", "purple", "midnight-blue", "orange", "yellow-green", "brass", "gray", "fuchsia", "yellow", "pink", "sky-blue", "green", "red", "black", "slate", "turquoise" ] }, "description": { "type": "string", "description": "The description of the Group." }, "display_icon_id": { "type": "string", "description": "The Icon id for the avatar of this Group." }, "member_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The Member ids to add to this Group." }, "mention_name": { "type": "string", "description": "The mention name of this Group." }, "name": { "type": "string", "description": "The name of this Group." }, "workflow_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The Workflow ids to add to the Group." } }, "required": [ "PCID", "mention_name", "name" ] } ``` *** ## shortcut\_projects\_create\_iteration Create Iteration **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- | | `description` | string | No | — | The description of the Iteration. | | `end_date` | string | Yes | — | The date this Iteration ends, e.g. 2019-07-01. | | `follower_ids` | string\[] | No | — | An array of UUIDs for any Members you want to add as Followers. | | `group_ids` | string\[] | No | — | An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI. | | `labels` | object\[] | No | — | An array of Labels attached to the Iteration. | | `name` | string | Yes | — | The name of this Iteration. | | `start_date` | string | Yes | — | The date this Iteration begins, e.g. 2019-07-01. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "The description of the Iteration." }, "end_date": { "type": "string", "description": "The date this Iteration ends, e.g. 2019-07-01." }, "follower_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs for any Members you want to add as Followers." }, "group_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI." }, "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 Iteration." }, "name": { "type": "string", "description": "The name of this Iteration." }, "start_date": { "type": "string", "description": "The date this Iteration begins, e.g. 2019-07-01." } }, "required": [ "PCID", "end_date", "name", "start_date" ] } ``` *** ## shortcut\_projects\_create\_label Create Label **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `color` | string | No | — | The hex color to be displayed with the Label (for example, "#ff0000"). | | `description` | string | No | — | The description of the new Label. | | `external_id` | string | No | — | 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. | | `name` | string | Yes | — | The name of the new Label. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "color": { "type": "string", "description": "The hex color to be displayed with the Label (for example, \"#ff0000\")." }, "description": { "type": "string", "description": "The description of the new Label." }, "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." }, "name": { "type": "string", "description": "The name of the new Label." } }, "required": [ "PCID", "name" ] } ``` *** ## shortcut\_projects\_create\_project Create Project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `abbreviation` | string | No | — | The Project abbreviation used in Story summaries. Should be kept to 3 characters at most. | | `color` | string | No | — | The color you wish to use for the Project in the system. | | `created_at` | string | No | — | Defaults to the time/date it is created but can be set to reflect another date. | | `description` | string | No | — | The Project description. | | `external_id` | string | No | — | This field can be set to another unique ID. In the case that the Project 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 Owners on this new Epic. | | `iteration_length` | integer | No | — | The number of weeks per iteration in this Project. | | `name` | string | Yes | — | The name of the Project. | | `start_time` | string | No | — | The date at which the Project was started. | | `team_id` | integer | Yes | — | The ID of the team the project belongs to. | | `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" }, "abbreviation": { "type": "string", "description": "The Project abbreviation used in Story summaries. Should be kept to 3 characters at most." }, "color": { "type": "string", "description": "The color you wish to use for the Project in the system." }, "created_at": { "type": "string", "description": "Defaults to the time/date it is created but can be set to reflect another date." }, "description": { "type": "string", "description": "The Project description." }, "external_id": { "type": "string", "description": "This field can be set to another unique ID. In the case that the Project 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 Owners on this new Epic." }, "iteration_length": { "type": "integer", "description": "The number of weeks per iteration in this Project." }, "name": { "type": "string", "description": "The name of the Project." }, "start_time": { "type": "string", "description": "The date at which the Project was started." }, "team_id": { "type": "integer", "description": "The ID of the team the project belongs to." }, "updated_at": { "type": "string", "description": "Defaults to the time/date it is created but can be set to reflect another date." } }, "required": [ "PCID", "name", "team_id" ] } ``` *** ## shortcut\_projects\_delete\_category Delete Category **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------ | | `category-public-id` | integer | Yes | — | The unique ID of the Category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category-public-id": { "type": "integer", "description": "The unique ID of the Category." } }, "required": [ "PCID", "category-public-id" ] } ``` *** ## shortcut\_projects\_delete\_custom\_field Delete Custom Field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------ | -------- | ------- | --------------------------------- | | `custom-field-public-id` | string | Yes | — | The unique ID of the CustomField. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom-field-public-id": { "type": "string", "description": "The unique ID of the CustomField." } }, "required": [ "PCID", "custom-field-public-id" ] } ``` *** ## shortcut\_projects\_delete\_iteration Delete Iteration **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------------- | | `iteration-public-id` | integer | Yes | — | The unique ID of the Iteration. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "iteration-public-id": { "type": "integer", "description": "The unique ID of the Iteration." } }, "required": [ "PCID", "iteration-public-id" ] } ``` *** ## shortcut\_projects\_delete\_label Delete Label **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------- | | `label-public-id` | integer | Yes | — | The unique ID of the Label. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "label-public-id": { "type": "integer", "description": "The unique ID of the Label." } }, "required": [ "PCID", "label-public-id" ] } ``` *** ## shortcut\_projects\_delete\_project Delete Project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ----------------------------- | | `project-public-id` | integer | Yes | — | The unique ID of the Project. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project-public-id": { "type": "integer", "description": "The unique ID of the Project." } }, "required": [ "PCID", "project-public-id" ] } ``` *** ## shortcut\_projects\_disable\_iterations Disable Iterations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## shortcut\_projects\_enable\_iterations Enable Iterations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## shortcut\_projects\_get\_category Get Category **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------ | | `category-public-id` | integer | Yes | — | The unique ID of the Category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category-public-id": { "type": "integer", "description": "The unique ID of the Category." } }, "required": [ "PCID", "category-public-id" ] } ``` *** ## shortcut\_projects\_get\_custom\_field Get Custom Field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------ | -------- | ------- | --------------------------------- | | `custom-field-public-id` | string | Yes | — | The unique ID of the CustomField. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom-field-public-id": { "type": "string", "description": "The unique ID of the CustomField." } }, "required": [ "PCID", "custom-field-public-id" ] } ``` *** ## shortcut\_projects\_get\_group Get Group **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | --------------------------- | | `group-public-id` | string | Yes | — | The unique ID of the Group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "group-public-id": { "type": "string", "description": "The unique ID of the Group." } }, "required": [ "PCID", "group-public-id" ] } ``` *** ## shortcut\_projects\_get\_iteration Get Iteration **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------------- | | `iteration-public-id` | integer | Yes | — | The unique ID of the Iteration. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "iteration-public-id": { "type": "integer", "description": "The unique ID of the Iteration." } }, "required": [ "PCID", "iteration-public-id" ] } ``` *** ## shortcut\_projects\_get\_label Get Label **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------- | | `label-public-id` | integer | Yes | — | The unique ID of the Label. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "label-public-id": { "type": "integer", "description": "The unique ID of the Label." } }, "required": [ "PCID", "label-public-id" ] } ``` *** ## shortcut\_projects\_get\_project Get Project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ----------------------------- | | `project-public-id` | integer | Yes | — | The unique ID of the Project. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project-public-id": { "type": "integer", "description": "The unique ID of the Project." } }, "required": [ "PCID", "project-public-id" ] } ``` *** ## shortcut\_projects\_get\_workflow Get Workflow **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ----------------------- | | `workflow-public-id` | integer | Yes | — | The ID of the Workflow. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflow-public-id": { "type": "integer", "description": "The ID of the Workflow." } }, "required": [ "PCID", "workflow-public-id" ] } ``` *** ## shortcut\_projects\_list\_categories List Categories ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## shortcut\_projects\_list\_category\_milestones List Category Milestones **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------ | | `category-public-id` | integer | Yes | — | The unique ID of the Category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category-public-id": { "type": "integer", "description": "The unique ID of the Category." } }, "required": [ "PCID", "category-public-id" ] } ``` *** ## shortcut\_projects\_list\_category\_objectives List Category Objectives **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------ | | `category-public-id` | integer | Yes | — | The unique ID of the Category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category-public-id": { "type": "integer", "description": "The unique ID of the Category." } }, "required": [ "PCID", "category-public-id" ] } ``` *** ## shortcut\_projects\_list\_custom\_fields List Custom Fields ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## shortcut\_projects\_list\_group\_stories List Group Stories **Parameters:** | Parameter | Type | Required | Default | 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) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "group-public-id": { "type": "string", "description": "The unique ID of the Group." }, "limit": { "type": "integer", "description": "The maximum number of results to return. (Defaults to 1000, max 1000)" }, "offset": { "type": "integer", "description": "The offset at which to begin returning results. (Defaults to 0)" } }, "required": [ "PCID", "group-public-id" ] } ``` *** ## shortcut\_projects\_list\_groups List Groups **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "archived": { "type": "boolean", "description": "Filter groups by their archived state. If true, returns only archived groups. If false, returns only unarchived groups. If not provided, returns all groups" } }, "required": [ "PCID" ] } ``` *** ## shortcut\_projects\_list\_iteration\_stories List Iteration Stories **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "iteration-public-id": { "type": "integer", "description": "The unique ID of the Iteration." }, "includes_description": { "type": "boolean", "description": "A true/false boolean indicating whether to return Stories with their descriptions." } }, "required": [ "PCID", "iteration-public-id" ] } ``` *** ## shortcut\_projects\_list\_iterations List Iterations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## shortcut\_projects\_list\_label\_epics List Label Epics **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------- | | `label-public-id` | integer | Yes | — | The unique ID of the Label. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "label-public-id": { "type": "integer", "description": "The unique ID of the Label." } }, "required": [ "PCID", "label-public-id" ] } ``` *** ## shortcut\_projects\_list\_label\_stories List Label Stories **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "label-public-id": { "type": "integer", "description": "The unique ID of the Label." }, "includes_description": { "type": "boolean", "description": "A true/false boolean indicating whether to return Stories with their descriptions." } }, "required": [ "PCID", "label-public-id" ] } ``` *** ## shortcut\_projects\_list\_labels List Labels **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------- | | `slim` | boolean | No | — | A true/false boolean indicating if the slim versions of the Label should be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "slim": { "type": "boolean", "description": "A true/false boolean indicating if the slim versions of the Label should be returned." } }, "required": [ "PCID" ] } ``` *** ## shortcut\_projects\_list\_projects List Projects ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## shortcut\_projects\_list\_stories List Stories **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project-public-id": { "type": "integer", "description": "The unique ID of the Project." }, "includes_description": { "type": "boolean", "description": "A true/false boolean indicating whether to return Stories with their descriptions." } }, "required": [ "PCID", "project-public-id" ] } ``` *** ## shortcut\_projects\_list\_workflows List Workflows ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## shortcut\_projects\_update\_category Update Category **Parameters:** | Parameter | Type | Required | Default | Description | | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------- | | `category-public-id` | integer | Yes | — | The unique ID of the Category you wish to update. | | | `archived` | boolean | No | — | A true/false boolean indicating if the Category has been archived. | | | `color` | string | null | No | — | The hex color to be displayed with the Category (for example, "#ff0000"). | | `name` | string | No | — | The new name of the Category. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category-public-id": { "type": "integer", "description": "The unique ID of the Category you wish to update." }, "archived": { "type": "boolean", "description": "A true/false boolean indicating if the Category has been archived." }, "color": { "type": [ "string", "null" ], "description": "The hex color to be displayed with the Category (for example, \"#ff0000\")." }, "name": { "type": "string", "description": "The new name of the Category." } }, "required": [ "PCID", "category-public-id" ] } ``` *** ## shortcut\_projects\_update\_custom\_field Update Custom Field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------- | | `custom-field-public-id` | string | Yes | — | The unique ID of the CustomField. | | `after_id` | string | No | — | The ID of the CustomField we want to move this CustomField after. | | `before_id` | string | No | — | The ID of the CustomField we want to move this CustomField before. | | `description` | string | No | — | A description of the purpose of this field. | | `enabled` | boolean | No | — | Indicates whether the Field is enabled for the Workspace. Only enabled fields can be applied to Stories. | | `icon_set_identifier` | string | No | — | A frontend-controlled string that represents the icon for this custom field. | | `name` | string | No | — | A collection of objects representing reporting periods for years. | | `values` | object\[] | No | — | A collection of EnumValue objects representing the values in the domain of some Custom Field. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom-field-public-id": { "type": "string", "description": "The unique ID of the CustomField." }, "after_id": { "type": "string", "description": "The ID of the CustomField we want to move this CustomField after." }, "before_id": { "type": "string", "description": "The ID of the CustomField we want to move this CustomField before." }, "description": { "type": "string", "description": "A description of the purpose of this field." }, "enabled": { "type": "boolean", "description": "Indicates whether the Field is enabled for the Workspace. Only enabled fields can be applied to Stories." }, "icon_set_identifier": { "type": "string", "description": "A frontend-controlled string that represents the icon for this custom field." }, "name": { "type": "string", "description": "A collection of objects representing reporting periods for years." }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique ID of an existing EnumValue within the CustomField's domain." }, "value": { "type": "string", "description": "A string value within the domain of this Custom Field." }, "color_key": { "type": "string", "enum": [ "blue", "purple", "midnight-blue", "orange", "yellow-green", "brass", "gray", "fuchsia", "yellow", "pink", "sky-blue", "green", "red", "black", "slate", "turquoise" ], "description": "A color key associated with this EnumValue within the CustomField's domain." }, "enabled": { "type": "boolean", "description": "Whether this EnumValue is enabled for its CustomField or not. Leaving this key out of the request leaves the current enabled state untouched." } } }, "description": "A collection of EnumValue objects representing the values in the domain of some Custom Field." } }, "required": [ "PCID", "custom-field-public-id" ] } ``` *** ## shortcut\_projects\_update\_group Update Group **Parameters:** | Parameter | Type | Required | Default | Description | | | --------------------- | ---------- | -------- | ------- | ---------------------------------------------------------- | ----------------------------------------------------------------- | | `group-public-id` | string | Yes | — | The unique ID of the Group. | | | `archived` | boolean | null | No | — | Whether or not this Group is archived. | | `color` | string | null | No | — | The color you wish to use for the Group in the system. | | `color_key` | string | No | — | The color key you wish to use for the Group in the system. | | | `default_workflow_id` | integer | null | No | — | The ID of the default workflow for stories created in this group. | | `description` | string | No | — | The description of this Group. | | | `display_icon_id` | string | null | No | — | The Icon id for the avatar of this Group. | | `member_ids` | string\[] | No | — | The Member ids to add to this Group. | | | `mention_name` | string | No | — | The mention name of this Group. | | | `name` | string | No | — | The name of this Group. | | | `workflow_ids` | integer\[] | No | — | The Workflow ids to add to the Group. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "group-public-id": { "type": "string", "description": "The unique ID of the Group." }, "archived": { "type": [ "boolean", "null" ], "description": "Whether or not this Group is archived." }, "color": { "type": [ "string", "null" ], "description": "The color you wish to use for the Group in the system." }, "color_key": { "type": "string", "description": "The color key you wish to use for the Group in the system.", "enum": [ "blue", "purple", "midnight-blue", "orange", "yellow-green", "brass", "gray", "fuchsia", "yellow", "pink", "sky-blue", "green", "red", "black", "slate", "turquoise" ] }, "default_workflow_id": { "type": [ "integer", "null" ], "description": "The ID of the default workflow for stories created in this group." }, "description": { "type": "string", "description": "The description of this Group." }, "display_icon_id": { "type": [ "string", "null" ], "description": "The Icon id for the avatar of this Group." }, "member_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The Member ids to add to this Group." }, "mention_name": { "type": "string", "description": "The mention name of this Group." }, "name": { "type": "string", "description": "The name of this Group." }, "workflow_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The Workflow ids to add to the Group." } }, "required": [ "PCID", "group-public-id" ] } ``` *** ## shortcut\_projects\_update\_iteration Update Iteration **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- | | `iteration-public-id` | integer | Yes | — | The unique ID of the Iteration. | | `description` | string | No | — | The description of the Iteration. | | `end_date` | string | No | — | The date this Iteration ends, e.g. 2019-07-05. | | `follower_ids` | string\[] | No | — | An array of UUIDs for any Members you want to add as Followers. | | `group_ids` | string\[] | No | — | An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI. | | `labels` | object\[] | No | — | An array of Labels attached to the Iteration. | | `name` | string | No | — | The name of this Iteration | | `start_date` | string | No | — | The date this Iteration begins, e.g. 2019-07-01 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "iteration-public-id": { "type": "integer", "description": "The unique ID of the Iteration." }, "description": { "type": "string", "description": "The description of the Iteration." }, "end_date": { "type": "string", "description": "The date this Iteration ends, e.g. 2019-07-05." }, "follower_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs for any Members you want to add as Followers." }, "group_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI." }, "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 Iteration." }, "name": { "type": "string", "description": "The name of this Iteration" }, "start_date": { "type": "string", "description": "The date this Iteration begins, e.g. 2019-07-01" } }, "required": [ "PCID", "iteration-public-id" ] } ``` *** ## shortcut\_projects\_update\_label Update Label **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------- | ---------------------------------------------------------------------- | | `label-public-id` | integer | Yes | — | The unique ID of the Label you wish to update. | | | `archived` | boolean | No | — | A true/false boolean indicating if the Label has been archived. | | | `color` | string | null | No | — | The hex color to be displayed with the Label (for example, "#ff0000"). | | `description` | string | No | — | The new description of the label. | | | `name` | string | No | — | The new name of the label. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "label-public-id": { "type": "integer", "description": "The unique ID of the Label you wish to update." }, "archived": { "type": "boolean", "description": "A true/false boolean indicating if the Label has been archived." }, "color": { "type": [ "string", "null" ], "description": "The hex color to be displayed with the Label (for example, \"#ff0000\")." }, "description": { "type": "string", "description": "The new description of the label." }, "name": { "type": "string", "description": "The new name of the label." } }, "required": [ "PCID", "label-public-id" ] } ``` *** ## shortcut\_projects\_update\_project Update Project **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------- | | `project-public-id` | integer | Yes | — | The unique ID of the Project. | | `abbreviation` | string | No | — | The Project abbreviation used in Story summaries. Should be kept to 3 characters at most. | | `archived` | boolean | No | — | A true/false boolean indicating whether the Story is in archived state. | | `color` | string | No | — | The color that represents the Project in the UI. | | `days_to_thermometer` | integer | No | — | The number of days before the thermometer appears in the Story summary. | | `description` | string | No | — | The Project's description. | | `follower_ids` | string\[] | No | — | An array of UUIDs for any Members you want to add as Followers. | | `name` | string | No | — | The Project's name. | | `show_thermometer` | boolean | No | — | Configuration to enable or disable thermometers in the Story summary. | | `team_id` | integer | No | — | The ID of the team the project belongs to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project-public-id": { "type": "integer", "description": "The unique ID of the Project." }, "abbreviation": { "type": "string", "description": "The Project abbreviation used in Story summaries. Should be kept to 3 characters at most." }, "archived": { "type": "boolean", "description": "A true/false boolean indicating whether the Story is in archived state." }, "color": { "type": "string", "description": "The color that represents the Project in the UI." }, "days_to_thermometer": { "type": "integer", "description": "The number of days before the thermometer appears in the Story summary." }, "description": { "type": "string", "description": "The Project's description." }, "follower_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs for any Members you want to add as Followers." }, "name": { "type": "string", "description": "The Project's name." }, "show_thermometer": { "type": "boolean", "description": "Configuration to enable or disable thermometers in the Story summary." }, "team_id": { "type": "integer", "description": "The ID of the team the project belongs to." } }, "required": [ "PCID", "project-public-id" ] } ```