/shortcut-projects | Type: Application | PCID required: Yes
Tools
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. |
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. |
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. |
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. |
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. |
shortcut_projects_delete_category
Delete Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category-public-id | integer | Yes | — | The unique ID of the Category. |
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. |
shortcut_projects_delete_iteration
Delete Iteration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
iteration-public-id | integer | Yes | — | The unique ID of the Iteration. |
shortcut_projects_delete_label
Delete Label Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
label-public-id | integer | Yes | — | The unique ID of the Label. |
shortcut_projects_delete_project
Delete Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-public-id | integer | Yes | — | The unique ID of the Project. |
shortcut_projects_disable_iterations
Disable Iterationsshortcut_projects_enable_iterations
Enable Iterationsshortcut_projects_get_category
Get Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category-public-id | integer | Yes | — | The unique ID of the Category. |
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. |
shortcut_projects_get_group
Get Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group-public-id | string | Yes | — | The unique ID of the Group. |
shortcut_projects_get_iteration
Get Iteration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
iteration-public-id | integer | Yes | — | The unique ID of the Iteration. |
shortcut_projects_get_label
Get Label Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
label-public-id | integer | Yes | — | The unique ID of the Label. |
shortcut_projects_get_project
Get Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-public-id | integer | Yes | — | The unique ID of the Project. |
shortcut_projects_get_workflow
Get Workflow Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workflow-public-id | integer | Yes | — | The ID of the Workflow. |
shortcut_projects_list_categories
List Categoriesshortcut_projects_list_category_milestones
List Category Milestones Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category-public-id | integer | Yes | — | The unique ID of the Category. |
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. |
shortcut_projects_list_custom_fields
List Custom Fieldsshortcut_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) |
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 |
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. |
shortcut_projects_list_iterations
List Iterationsshortcut_projects_list_label_epics
List Label Epics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
label-public-id | integer | Yes | — | The unique ID of the Label. |
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. |
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. |
shortcut_projects_list_projects
List Projectsshortcut_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. |
shortcut_projects_list_workflows
List Workflowsshortcut_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 | No | — | The hex color to be displayed with the Category (for example, “#ff0000”). |
name | string | No | — | The new name of the Category. |
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. |
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 | No | — | Whether or not this Group is archived. |
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. |
default_workflow_id | integer | 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 | 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. |
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 |
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 | 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. |
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. |

