Shortcut

shortcut

Shortcut aligns product development work with company objectives so teams can execute with a shared purpose.

Project Management Product Management Web del proveedor

Acciones

122

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (122)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create categorySHORTCUT_CREATE_CATEGORYAcción

Create category allows you to create a new category in shortcut.

Parámetros de entrada

namestringObligatorio
The name of the new Category.
colorstringcss-color
The hex color to be displayed with the Category (for example, "#ff0000").
external_idstring
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.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create entity templateSHORTCUT_CREATE_ENTITY_TEMPLATEAcción

Create a new entity template for the workspace.

Parámetros de entrada

namestringObligatorio
The name of the new entity template
author_idstringuuid
The id of the user creating this template.
story__contents__namestring
The name of the story.
story__contents__tasksobject[]
An array of tasks to be populated by the template.
story__contents__labelsobject[]
An array of labels to be populated by the template.
story__contents__deadlinestringdate-time
The due date of the story.
story__contents__epic__idinteger
The ID of the epic the to be populated.
story__contents__estimateinteger
The numeric point estimate to be populated.
story__contents__file__idsinteger[]
An array of the attached file IDs to be populated.
story__contents__group__idstringuuid
The ID of the group to be populated.
story__contents__owner__idsstring[]
An array of UUIDs of the owners of this story.
story__contents__descriptionstring
The description of the story.
story__contents__project__idinteger
The ID of the project the story belongs to.
story__contents__story__typestring
The type of story (feature, bug, chore).
story__contents__follower__idsstring[]
An array of UUIDs for any Members listed as Followers.
story__contents__iteration__idinteger
The ID of the iteration the to be populated.
story__contents__custom__fieldsobject[]
An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
story__contents__external__linksstring[]
An array of external links to be populated.
story__contents__linked__file__idsinteger[]
An array of the linked file IDs to be populated.
story__contents__workflow__state__idinteger
The ID of the workflow state to be populated.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create epicSHORTCUT_CREATE_EPICAcción

Create epic allows you to create a new epic in shortcut.

Parámetros de entrada

namestringObligatorio
The Epic"s name.
statestringenum
`Deprecated` The Epic"s state (to do, in progress, or done); will be ignored when `epic_state_id` is set.
in progressto dodone
labelsobject[]
An array of Labels attached to the Epic.
deadlinestringdate-time
The Epic"s deadline.
group_idstringuuid
`Deprecated` The ID of the group to associate with the epic. Use `group_ids`.
group_idsstring[]
An array of UUIDS for Groups to which this Epic is related.
owner_idsstring[]
An array of UUIDs for any members you want to add as Owners on this new Epic.
created_atstringdate-time
Defaults to the time/date it is created but can be set to reflect another date.
updated_atstringdate-time
Defaults to the time/date it is created but can be set to reflect another date.
descriptionstring
The Epic"s description.
external_idstring
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_idsstring[]
An array of UUIDs for any Members you want to add as Followers on this new Epic.
milestone_idinteger
`Deprecated` The ID of the Milestone this Epic is related to. Use `objective_ids`.
epic_state_idinteger
The ID of the Epic State.
objective_idsinteger[]
An array of IDs for Objectives to which this Epic is related.
requested_by_idstringuuid
The ID of the member that requested the epic.
planned_start_datestringdate-time
The Epic"s planned start date.
started_at_overridestringdate-time
A manual override for the time/date the Epic was started.
completed_at_overridestringdate-time
A manual override for the time/date the Epic was completed.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create epic commentSHORTCUT_CREATE_EPIC_COMMENTAcción

This endpoint allows you to create a threaded comment on an epic.

Parámetros de entrada

textstringObligatorio
The comment text.
author_idstringuuid
The Member ID of the Comment"s author. Defaults to the user identified by the API token.
created_atstringdate-time
Defaults to the time/date the comment is created, but can be set to reflect another date.
updated_atstringdate-time
Defaults to the time/date the comment is last updated, but can be set to reflect another date.
external_idstring
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.
epic__public__idintegerObligatorio
The ID of the associated Epic.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create epic comment commentSHORTCUT_CREATE_EPIC_COMMENT_COMMENTAcción

This endpoint allows you to create a nested comment reply to an existing epic comment.

Parámetros de entrada

textstringObligatorio
The comment text.
author_idstringuuid
The Member ID of the Comment"s author. Defaults to the user identified by the API token.
created_atstringdate-time
Defaults to the time/date the comment is created, but can be set to reflect another date.
updated_atstringdate-time
Defaults to the time/date the comment is last updated, but can be set to reflect another date.
external_idstring
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.
epic__public__idintegerObligatorio
The ID of the associated Epic.
comment__public__idintegerObligatorio
The ID of the parent Epic Comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create groupSHORTCUT_CREATE_GROUPAcción

Creates a new group in the shortcut system with customizable properties. this endpoint allows you to set up a group with a unique mention name, display name, optional description, and various customization options. use this when you need to establish a new team, department, or any other collective within your shortcut workspace. the created group can include members, associated workflows, and visual customizations like color and icon. this endpoint is particularly useful for organizing your shortcut workspace structure, facilitating team collaboration, and streamlining workflow management. note that while member and workflow associations can be set during creation, they can also be modified later using separate endpoints.

Parámetros de entrada

namestringObligatorio
The name of this Group.
colorstringcss-color
The color you wish to use for the Group in the system.
color_keystringenum
The color key you wish to use for the Group in the system.
bluepurplemidnight-blueorangeyellow-greenbrassgrayfuchsiayellowpinksky-bluegreen+4
member_idsstring[]
The Member ids to add to this Group.
descriptionstring
The description of the Group.
mention_namestringObligatorio
The mention name of this Group.
workflow_idsinteger[]
The Workflow ids to add to the Group.
display_icon_idstringuuid
The Icon id for the avatar of this Group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create iterationSHORTCUT_CREATE_ITERATIONAcción

The createiteration endpoint allows you to create a new iteration in shortcut, which represents a time-boxed period for completing a set of stories or tasks. this endpoint is crucial for teams using agile methodologies, enabling them to plan and track progress over specific time periods. use this endpoint when setting up sprint cycles, planning releases, or organizing work into manageable timeframes. the endpoint requires essential information such as the iteration's name and date range, while also offering options to add followers, associate groups, and attach labels for better organization and tracking. it's important to note that while multiple groups can be added via the api, the current web ui only displays one group association. this endpoint should not be used for modifying existing iterations; instead, use the dedicated update endpoint for such changes.

Parámetros de entrada

namestringObligatorio
The name of this Iteration.
labelsobject[]
An array of Labels attached to the Iteration.
end_datestringObligatorio
The date this Iteration ends, e.g. 2019-07-01.
group_idsstring[]
An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI.
start_datestringObligatorio
The date this Iteration begins, e.g. 2019-07-01.
descriptionstring
The description of the Iteration.
follower_idsstring[]
An array of UUIDs for any Members you want to add as Followers.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create labelSHORTCUT_CREATE_LABELAcción

Create label allows you to create a new label in shortcut.

Parámetros de entrada

namestringObligatorio
The name of the new Label.
colorstringcss-color
The hex color to be displayed with the Label (for example, "#ff0000").
descriptionstring
The description of the new Label.
external_idstring
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.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create linked fileSHORTCUT_CREATE_LINKED_FILEAcción

Create linked file allows you to create a new linked file in shortcut.

Parámetros de entrada

urlstringObligatorio
The URL of linked file.
namestringObligatorio
The name of the file.
sizeinteger
The filesize, if the integration provided it.
typestringObligatorioenum
The integration type of the file (e.g. google, dropbox, box).
googleurldropboxboxonedrive
story_idinteger
The ID of the linked story.
descriptionstring
The description of the file.
uploader_idstringuuid
The UUID of the member that uploaded the file.
content_typestring
The content type of the image (e.g. txt/plain).
thumbnail_urlstring
The URL of the thumbnail, if the integration provided it.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create milestoneSHORTCUT_CREATE_MILESTONEAcción

(deprecated: use 'create objective') create milestone allows you to create a new milestone in shortcut.

Parámetros de entrada

namestringObligatorio
The name of the Milestone.
statestringenum
The workflow state that the Milestone is in.
in progressto dodone
categoriesobject[]
An array of IDs of Categories attached to the Milestone.
descriptionstring
The Milestone"s description.
started_at_overridestringdate-time
A manual override for the time/date the Milestone was started.
completed_at_overridestringdate-time
A manual override for the time/date the Milestone was completed.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create multiple storiesSHORTCUT_CREATE_MULTIPLE_STORIESAcción

Create multiple stories allows you to create multiple stories in a single request using the same syntax as [create story](https://developer.shortcut.com/api/rest/v3#create-story).

Parámetros de entrada

storiesobject[]Obligatorio
An array of stories to be created.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create objectiveSHORTCUT_CREATE_OBJECTIVEAcción

Create objective allows you to create a new objective in shortcut.

Parámetros de entrada

namestringObligatorio
The name of the Objective.
statestringenum
The workflow state that the Objective is in.
in progressto dodone
categoriesobject[]
An array of IDs of Categories attached to the Objective.
descriptionstring
The Objective"s description.
started_at_overridestringdate-time
A manual override for the time/date the Objective was started.
completed_at_overridestringdate-time
A manual override for the time/date the Objective was completed.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create projectSHORTCUT_CREATE_PROJECTAcción

Create project is used to create a new shortcut project.

Parámetros de entrada

namestringObligatorio
The name of the Project.
colorstringcss-color
The color you wish to use for the Project in the system.
team_idintegerObligatorio
The ID of the team the project belongs to.
created_atstringdate-time
Defaults to the time/date it is created but can be set to reflect another date.
start_timestringdate-time
The date at which the Project was started.
updated_atstringdate-time
Defaults to the time/date it is created but can be set to reflect another date.
descriptionstring
The Project description.
external_idstring
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.
abbreviationstring
The Project abbreviation used in Story summaries. Should be kept to 3 characters at most.
follower_idsstring[]
An array of UUIDs for any members you want to add as Owners on this new Epic.
iteration_lengthinteger
The number of weeks per iteration in this Project.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create storySHORTCUT_CREATE_STORYAcción

Create story is used to add a new story to your shortcut workspace. this endpoint requires that either **workflow state id** or **project id** be provided, but will reject the request if both or neither are specified. the workflow state id has been marked as required and is the recommended field to specify because we are in the process of sunsetting projects in shortcut.

Parámetros de entrada

namestringObligatorio
The name of the story.
tasksobject[]
An array of tasks connected to the story.
labelsobject[]
An array of labels attached to the story.
epic_idinteger
The ID of the epic the story belongs to.
move_tostringenum
One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.
lastfirst
archivedboolean
Controls the story"s archived state.
commentsobject[]
An array of comments to add to the story.
deadlinestringdate-time
The due date of the story.
estimateinteger
The numeric point estimate of the story. Can also be null, which means unestimated.
file_idsinteger[]
An array of IDs of files attached to the story.
group_idstringuuid
The id of the group to associate with this story.
owner_idsstring[]
An array of UUIDs of the owners of this story.
sub_tasksobject[]
An array of sub tasks to create.
created_atstringdate-time
The time/date the Story was created.
project_idinteger
The ID of the project the story belongs to.
story_typestringenum
The type of story (feature, bug, chore).
featurechorebug
updated_atstringdate-time
The time/date the Story was updated.
descriptionstring
The description of the story.
external_idstring
This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.
story_linksobject[]
An array of story links attached to the story.
follower_idsstring[]
An array of UUIDs of the followers of this story.
iteration_idinteger
The ID of the iteration the story belongs to.
custom_fieldsobject[]
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
external_linksstring[]
An array of External Links associated with this story.
source_task_idinteger
Given this story was converted from a task in another story, this is the original task ID that was converted to this story.
linked_file_idsinteger[]
An array of IDs of linked files attached to the story.
requested_by_idstringuuid
The ID of the member that requested the story.
story_template_idstringuuid
The id of the story template used to create this story, if applicable. This is just an association; no content from the story template is inherited by the story simply by setting this field.
workflow_state_idinteger
The ID of the workflow state the story will be in.
started_at_overridestringdate-time
A manual override for the time/date the Story was started.
completed_at_overridestringdate-time
A manual override for the time/date the Story was completed.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create story commentSHORTCUT_CREATE_STORY_COMMENTAcción

Create comment allows you to create a comment on any story.

Parámetros de entrada

textstringObligatorio
The comment text.
author_idstringuuid
The Member ID of the Comment"s author. Defaults to the user identified by the API token.
parent_idinteger
The ID of the Comment that this comment is threaded under.
created_atstringdate-time
Defaults to the time/date the comment is created, but can be set to reflect another date.
updated_atstringdate-time
Defaults to the time/date the comment is last updated, but can be set to reflect another date.
external_idstring
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.
story__public__idintegerObligatorio
The ID of the Story that the Comment is in.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create story from templateSHORTCUT_CREATE_STORY_FROM_TEMPLATEAcción

Create story from template is used to add a new story derived from a template to your shortcut workspace.

Parámetros de entrada

namestring
The name of the story. Must be provided if the template does not provide a name.
tasksobject[]
An array of tasks connected to the story.
labelsobject[]
An array of labels attached to the story.
epic_idinteger
The ID of the epic the story belongs to.
move_tostringenum
One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.
lastfirst
archivedboolean
Controls the story"s archived state.
commentsobject[]
An array of comments to add to the story.
deadlinestringdate-time
The due date of the story.
estimateinteger
The numeric point estimate of the story. Can also be null, which means unestimated.
file_idsinteger[]
An array of IDs of files attached to the story.
group_idstringuuid
The id of the group to associate with this story.
owner_idsstring[]
An array of UUIDs of the owners of this story.
sub_tasksobject[]
An array of sub tasks to create.
created_atstringdate-time
The time/date the Story was created.
labels_addobject[]
An array of labels attached to the story in addition to the labels provided by the template. Cannot be used in conjunction with `labels`.
project_idinteger
The ID of the project the story belongs to.
story_typestringenum
The type of story (feature, bug, chore).
featurechorebug
updated_atstringdate-time
The time/date the Story was updated.
descriptionstring
The description of the story.
external_idstring
This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.
story_linksobject[]
An array of story links attached to the story.
file_ids_addinteger[]
An array of IDs of files attached to the story in addition to files from the template. Cannot be used in conjunction with `file_ids`.
follower_idsstring[]
An array of UUIDs of the followers of this story.
iteration_idinteger
The ID of the iteration the story belongs to.
custom_fieldsobject[]
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
labels_removeobject[]
An array of labels to remove from the labels provided by the template. Cannot be used in conjunction with `labels`.
owner_ids_addstring[]
The UUIDs of the new owners to be added in addition to owners from the template. Cannot be used in conjunction with `owners`.
external_linksstring[]
An array of External Links associated with this story.
source_task_idinteger
Given this story was converted from a task in another story, this is the original task ID that was converted to this story.
file_ids_removeinteger[]
An array of IDs of files removed from files from the template. Cannot be used in conjunction with `file_ids`.
linked_file_idsinteger[]
An array of IDs of linked files attached to the story.
requested_by_idstringuuid
The ID of the member that requested the story.
follower_ids_addstring[]
The UUIDs of the new followers to be added in addition to followers from the template. Cannot be used in conjunction with `follower_ids.`
owner_ids_removestring[]
The UUIDs of the new owners to be removed from owners from the template. Cannot be used in conjunction with `owners`.
custom_fields_addobject[]
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. These will be added to any fields provided by the template. Cannot be used in conjunction with `custom_fields`.
story_template_idstringObligatoriouuid
The id of the story template used to create this story.
workflow_state_idinteger
The ID of the workflow state the story will be in.
external_links_addstring[]
An array of External Links associated with this story. These will be added to any links provided by the template. Cannot be used in conjunction with `external_links`.
follower_ids_removestring[]
The UUIDs of the new followers to be removed from followers from the template. Cannot be used in conjunction with `follower_ids`.
linked_file_ids_addinteger[]
An array of IDs of linked files attached to the story in addition to files from the template. Cannot be used in conjunction with `linked_files`.
started_at_overridestringdate-time
A manual override for the time/date the Story was started.
custom_fields_removeobject[]
A map specifying a CustomField ID. These will be removed from any fields provided by the template. Cannot be used in conjunction with `custom_fields`.
completed_at_overridestringdate-time
A manual override for the time/date the Story was completed.
external_links_removestring[]
An array of External Links associated with this story. These will be removed from any links provided by the template. Cannot be used in conjunction with `external_links`.
linked_file_ids_removeinteger[]
An array of IDs of linked files removed from files from the template. Cannot be used in conjunction with `linked_files.`

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create story linkSHORTCUT_CREATE_STORY_LINKAcción

Story links (called story relationships in the ui) allow you create semantic relationships between two stories. the parameters read like an active voice grammatical sentence: subject -> verb -> object. the subject story acts on the object story; the object story is the direct object of the sentence. the subject story "blocks", "duplicates", or "relates to" the object story. examples: - "story 5 blocks story 6” -- story 6 is now "blocked" until story 5 is moved to a done workflow state. - "story 2 duplicates story 1” -- story 2 represents the same body of work as story 1 (and should probably be archived). - "story 7 relates to story 3”

Parámetros de entrada

verbstringObligatorioenum
The type of link.
blocksduplicatesrelates to
object_idintegerObligatorio
The ID of the object Story.
subject_idintegerObligatorio
The ID of the subject Story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create story reactionSHORTCUT_CREATE_STORY_REACTIONAcción

Create a reaction to a story comment.

Parámetros de entrada

emojistringObligatorio
The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`.
story__public__idintegerObligatorio
The ID of the Story that the Comment is in.
comment__public__idintegerObligatorio
The ID of the Comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create taskSHORTCUT_CREATE_TASKAcción

Create task is used to create a new task in a story.

Parámetros de entrada

completeboolean
True/false boolean indicating whether the Task is completed. Defaults to false.
owner_idsstring[]
An array of UUIDs for any members you want to add as Owners on this new Task.
created_atstringdate-time
Defaults to the time/date the Task is created but can be set to reflect another creation time/date.
updated_atstringdate-time
Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date.
descriptionstringObligatorio
The Task description.
external_idstring
This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here.
story__public__idintegerObligatorio
The ID of the Story that the Task will be in.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete categorySHORTCUT_DELETE_CATEGORYAcción

Delete category can be used to delete any category.

Parámetros de entrada

category__public__idintegerObligatorio
The unique ID of the Category.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete custom fieldSHORTCUT_DELETE_CUSTOM_FIELDAcción

Deletes a specific custom field from the shortcut system using its unique public identifier. this endpoint should be used when you need to permanently remove a custom field that is no longer required in your workflows or project structure. it's important to note that this operation is irreversible, and once a custom field is deleted, all data associated with it will be lost. use this endpoint with caution, ensuring that the custom field is no longer needed and that its deletion won't negatively impact any existing processes or data integrity within your shortcut instance.

Parámetros de entrada

custom__field__public__idstringObligatorio
The unique ID of the CustomField.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete entity templateSHORTCUT_DELETE_ENTITY_TEMPLATEAcción

Deletes a specific entity template from the shortcut api. this endpoint should be used when you need to permanently remove a template that is no longer needed or is obsolete. it's important to note that this operation cannot be undone, so it should be used with caution. the deletion is performed on a single template identified by its public id, adhering to the best practice of controlling deletion on a per-resource basis. this endpoint is part of the api v3, which may include enhanced features or changes compared to previous versions.

Parámetros de entrada

entity__template__public__idstringObligatorio
The unique ID of the entity template.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete epicSHORTCUT_DELETE_EPICAcción

Delete epic can be used to delete the epic. the only required parameter is epic id.

Parámetros de entrada

epic__public__idintegerObligatorio
The unique ID of the Epic.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete epic commentSHORTCUT_DELETE_EPIC_COMMENTAcción

This endpoint allows you to delete a comment from an epic.

Parámetros de entrada

epic__public__idintegerObligatorio
The ID of the associated Epic.
comment__public__idintegerObligatorio
The ID of the Comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete fileSHORTCUT_DELETE_FILEAcción

Delete file deletes a previously uploaded file.

Parámetros de entrada

file__public__idintegerObligatorio
The File’s unique ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete iterationSHORTCUT_DELETE_ITERATIONAcción

Deletes a specific iteration from the shortcut project management system. this endpoint should be used when you need to permanently remove an iteration and all its associated data from your project workflow. it's particularly useful for cleaning up completed or cancelled iterations that are no longer needed. be cautious when using this endpoint, as the deletion is irreversible and will remove all data associated with the specified iteration. ensure you have the correct iteration id before proceeding with the deletion to avoid unintended data loss.

Parámetros de entrada

iteration__public__idintegerObligatorio
The unique ID of the Iteration.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete labelSHORTCUT_DELETE_LABELAcción

Delete label can be used to delete any label.

Parámetros de entrada

label__public__idintegerObligatorio
The unique ID of the Label.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete linked fileSHORTCUT_DELETE_LINKED_FILEAcción

Delete linked file can be used to delete any previously attached linked-file.

Parámetros de entrada

linked__file__public__idintegerObligatorio
The unique identifier of the linked file.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete milestoneSHORTCUT_DELETE_MILESTONEAcción

(deprecated: use 'delete objective') delete milestone can be used to delete any milestone.

Parámetros de entrada

milestone__public__idintegerObligatorio
The ID of the Milestone.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple storiesSHORTCUT_DELETE_MULTIPLE_STORIESAcción

Delete multiple stories allows you to delete multiple archived stories at once.

Parámetros de entrada

story_idsinteger[]Obligatorio
An array of IDs of Stories to delete.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete objectiveSHORTCUT_DELETE_OBJECTIVEAcción

Delete objective can be used to delete any objective.

Parámetros de entrada

objective__public__idintegerObligatorio
The ID of the Objective.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete projectSHORTCUT_DELETE_PROJECTAcción

Delete project can be used to delete a project. projects can only be deleted if all associated stories are moved or deleted. in the case that the project cannot be deleted, you will receive a 422 response.

Parámetros de entrada

project__public__idintegerObligatorio
The unique ID of the Project.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete storySHORTCUT_DELETE_STORYAcción

Delete story can be used to delete any story.

Parámetros de entrada

story__public__idintegerObligatorio
The ID of the Story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete story commentSHORTCUT_DELETE_STORY_COMMENTAcción

Delete a comment from any story.

Parámetros de entrada

story__public__idintegerObligatorio
The ID of the Story that the Comment is in.
comment__public__idintegerObligatorio
The ID of the Comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete story linkSHORTCUT_DELETE_STORY_LINKAcción

Removes the relationship between the stories for the given story link.

Parámetros de entrada

story__link__public__idintegerObligatorio
The unique ID of the Story Link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete story reactionSHORTCUT_DELETE_STORY_REACTIONAcción

Delete a reaction from any story comment.

Parámetros de entrada

emojistringObligatorio
The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`.
story__public__idintegerObligatorio
The ID of the Story that the Comment is in.
comment__public__idintegerObligatorio
The ID of the Comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete taskSHORTCUT_DELETE_TASKAcción

Delete task can be used to delete any previously created task on a story.

Parámetros de entrada

task__public__idintegerObligatorio
The unique ID of the Task.
story__public__idintegerObligatorio
The unique ID of the Story this Task is associated with.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Disable iterationsSHORTCUT_DISABLE_ITERATIONSAcción

Disables iterations for the current workspace

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Disable story templatesSHORTCUT_DISABLE_STORY_TEMPLATESAcción

Disables the story template feature for the workspace.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Enable iterationsSHORTCUT_ENABLE_ITERATIONSAcción

Enables iterations for the current workspace

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Enable story templatesSHORTCUT_ENABLE_STORY_TEMPLATESAcción

Enables the story template feature for the workspace.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get categorySHORTCUT_GET_CATEGORYAcción

Get category returns information about the selected category.

Parámetros de entrada

category__public__idintegerObligatorio
The unique ID of the Category.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get current member infoSHORTCUT_GET_CURRENT_MEMBER_INFOAcción

Returns information about the authenticated member.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get custom fieldSHORTCUT_GET_CUSTOM_FIELDAcción

Retrieves detailed information about a specific custom field in shortcut using its unique public identifier. this endpoint allows developers to fetch the properties and configuration of a custom field, which can include its name, type, possible values, and any other associated metadata. it's particularly useful when you need to inspect or validate a custom field's settings programmatically, or when integrating custom field data into external systems. the endpoint should be used when detailed information about a single custom field is required, rather than for bulk operations or listing all custom fields. note that this endpoint only provides read access to custom field data and cannot be used to modify the custom field.

Parámetros de entrada

custom__field__public__idstringObligatorio
The unique ID of the CustomField.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get entity templateSHORTCUT_GET_ENTITY_TEMPLATEAcción

Get entity template returns information about a given entity template.

Parámetros de entrada

entity__template__public__idstringObligatorio
The unique ID of the entity template.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get epicSHORTCUT_GET_EPICAcción

Get epic returns information about the selected epic.

Parámetros de entrada

epic__public__idintegerObligatorio
The unique ID of the Epic.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get epic commentSHORTCUT_GET_EPIC_COMMENTAcción

This endpoint returns information about the selected epic comment.

Parámetros de entrada

epic__public__idintegerObligatorio
The ID of the associated Epic.
comment__public__idintegerObligatorio
The ID of the Comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get epic workflowSHORTCUT_GET_EPIC_WORKFLOWAcción

Returns the epic workflow for the workspace.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get external link storiesSHORTCUT_GET_EXTERNAL_LINK_STORIESAcción

Get stories which have a given external link associated with them.

Parámetros de entrada

external_linkstringObligatorio
The external link associated with one or more stories.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get fileSHORTCUT_GET_FILEAcción

Get file returns information about the selected uploadedfile.

Parámetros de entrada

file__public__idintegerObligatorio
The File’s unique ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get groupSHORTCUT_GET_GROUPAcción

Retrieves detailed information about a specific group in the shortcut workspace using its unique public identifier. this endpoint allows developers to fetch comprehensive data about a group, including its name, type, and associated metadata. it's particularly useful when you need to access or verify group details programmatically, such as during workflow automations or when building integrations that involve group management. the endpoint provides more granular control and information compared to what's available through the web application, making it valuable for advanced group-related operations and data analysis within your shortcut projects.

Parámetros de entrada

group__public__idstringObligatorio
The unique ID of the Group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get iterationSHORTCUT_GET_ITERATIONAcción

Retrieves detailed information about a specific iteration in the shortcut project management system. this endpoint allows users to fetch comprehensive data about a single iteration, including its name, status, start and end dates, associated stories, and progress metrics. it should be used when detailed information about a particular iteration is needed, such as during sprint planning, progress tracking, or retrospective analysis. the endpoint provides a snapshot of the iteration at the time of the request and does not include real-time updates. it's particularly useful for project managers, scrum masters, and team members who need to review or report on iteration-specific data. note that this endpoint only retrieves information and does not allow for modification of the iteration details.

Parámetros de entrada

iteration__public__idintegerObligatorio
The unique ID of the Iteration.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get key resultSHORTCUT_GET_KEY_RESULTAcción

Get key result returns information about a chosen key result.

Parámetros de entrada

key__result__public__idstringObligatorio
The ID of the Key Result.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get labelSHORTCUT_GET_LABELAcción

Get label returns information about the selected label.

Parámetros de entrada

label__public__idintegerObligatorio
The unique ID of the Label.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get linked fileSHORTCUT_GET_LINKED_FILEAcción

Get file returns information about the selected linked file.

Parámetros de entrada

linked__file__public__idintegerObligatorio
The unique identifier of the linked file.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get memberSHORTCUT_GET_MEMBERAcción

Returns information about a member.

Parámetros de entrada

org__public__idstring
The unique ID of the Organization to limit the lookup to.
member__public__idstringObligatorio
The Member"s unique ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get milestoneSHORTCUT_GET_MILESTONEAcción

(deprecated: use 'get objective') get milestone returns information about a chosen milestone.

Parámetros de entrada

milestone__public__idintegerObligatorio
The ID of the Milestone.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get objectiveSHORTCUT_GET_OBJECTIVEAcción

Get objective returns information about a chosen objective.

Parámetros de entrada

objective__public__idintegerObligatorio
The ID of the Objective.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get projectSHORTCUT_GET_PROJECTAcción

Get project returns information about the selected project.

Parámetros de entrada

project__public__idintegerObligatorio
The unique ID of the Project.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get repositorySHORTCUT_GET_REPOSITORYAcción

Get repository returns information about the selected repository.

Parámetros de entrada

repo__public__idintegerObligatorio
The unique ID of the Repository.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get storySHORTCUT_GET_STORYAcción

Get story returns information about a chosen story.

Parámetros de entrada

story__public__idintegerObligatorio
The ID of the Story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get story commentSHORTCUT_GET_STORY_COMMENTAcción

Get comment is used to get comment information.

Parámetros de entrada

story__public__idintegerObligatorio
The ID of the Story that the Comment is in.
comment__public__idintegerObligatorio
The ID of the Comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get story linkSHORTCUT_GET_STORY_LINKAcción

Returns the stories and their relationship for the given story link.

Parámetros de entrada

story__link__public__idintegerObligatorio
The unique ID of the Story Link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get taskSHORTCUT_GET_TASKAcción

Returns information about a chosen task.

Parámetros de entrada

task__public__idintegerObligatorio
The unique ID of the Task.
story__public__idintegerObligatorio
The unique ID of the Story this Task is associated with.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get workflowSHORTCUT_GET_WORKFLOWAcción

Get workflow returns information about a chosen workflow.

Parámetros de entrada

workflow__public__idintegerObligatorio
The ID of the Workflow.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List categoriesSHORTCUT_LIST_CATEGORIESAcción

List categories returns a list of all categories and their attributes.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List category milestonesSHORTCUT_LIST_CATEGORY_MILESTONESAcción

List category milestones returns a list of all milestones with the category.

Parámetros de entrada

category__public__idintegerObligatorio
The unique ID of the Category.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List category objectivesSHORTCUT_LIST_CATEGORY_OBJECTIVESAcción

Returns a list of all objectives with the category.

Parámetros de entrada

category__public__idintegerObligatorio
The unique ID of the Category.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List custom fieldsSHORTCUT_LIST_CUSTOM_FIELDSAcción

Retrieves a list of all custom fields defined in the shortcut api. this endpoint allows developers to fetch information about user-defined fields that have been added to extend the functionality of standard fields in integrations. it's particularly useful when you need to understand the structure and types of custom data being used across the system. the endpoint returns details about each custom field, which may include their identifiers, names, types, and any associated metadata. use this endpoint when you need to inventory existing custom fields, prepare for data migrations, or dynamically adjust your application's data model to accommodate custom fields. note that this endpoint does not create, modify, or delete custom fields; it's purely for retrieval of existing custom field definitions.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List entity templatesSHORTCUT_LIST_ENTITY_TEMPLATESAcción

List all the entity templates for the workspace.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List epic commentsSHORTCUT_LIST_EPIC_COMMENTSAcción

Get a list of all comments on an epic.

Parámetros de entrada

epic__public__idintegerObligatorio
The unique ID of the Epic.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List epicsSHORTCUT_LIST_EPICSAcción

List epics returns a list of all epics and their attributes.

Parámetros de entrada

includes_descriptionboolean
A true/false boolean indicating whether to return Epics with their descriptions.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List epic storiesSHORTCUT_LIST_EPIC_STORIESAcción

Get a list of all stories in an epic.

Parámetros de entrada

epic__public__idintegerObligatorio
The unique ID of the Epic.
includes_descriptionboolean
A true/false boolean indicating whether to return Stories with their descriptions.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List filesSHORTCUT_LIST_FILESAcción

List files returns a list of all uploadedfiles in the workspace.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List groupsSHORTCUT_LIST_GROUPSAcción

A group in our api maps to a "team" within the shortcut product. a team is a collection of users that can be associated to stories, epics, and iterations within shortcut.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List group storiesSHORTCUT_LIST_GROUP_STORIESAcción

List the stories assigned to the group. (by default, limited to 1,000).

Parámetros de entrada

limitinteger
The maximum number of results to return. (Defaults to 1000, max 1000)
offsetinteger
The offset at which to begin returning results. (Defaults to 0)
group__public__idstringObligatorio
The unique ID of the Group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List iterationsSHORTCUT_LIST_ITERATIONSAcción

Retrieves a list of all iterations in the shortcut project management system. iterations represent specific time periods for planning and tracking work, allowing teams to organize their development cycles. this endpoint provides comprehensive information about each iteration, including its name, start and end dates, status, and associated stories or tasks. use this endpoint when you need an overview of all iterations for project planning, progress tracking, or reporting purposes. it's particularly useful for analyzing past performance, planning future sprints, or getting a high-level view of the project timeline. note that the response may be paginated for projects with a large number of iterations, and you might need to make multiple requests to retrieve the full dataset.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List iteration storiesSHORTCUT_LIST_ITERATION_STORIESAcción

Get a list of all stories in an iteration.

Parámetros de entrada

includes_descriptionboolean
A true/false boolean indicating whether to return Stories with their descriptions.
iteration__public__idintegerObligatorio
The unique ID of the Iteration.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List label epicsSHORTCUT_LIST_LABEL_EPICSAcción

List all of the epics with the label.

Parámetros de entrada

label__public__idintegerObligatorio
The unique ID of the Label.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List labelsSHORTCUT_LIST_LABELSAcción

List labels returns a list of all labels and their attributes.

Parámetros de entrada

slimboolean
A true/false boolean indicating if the slim versions of the Label should be returned.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List label storiesSHORTCUT_LIST_LABEL_STORIESAcción

List all of the stories with the label.

Parámetros de entrada

label__public__idintegerObligatorio
The unique ID of the Label.
includes_descriptionboolean
A true/false boolean indicating whether to return Stories with their descriptions.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List linked filesSHORTCUT_LIST_LINKED_FILESAcción

List linked files returns a list of all linked-files and their attributes.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List membersSHORTCUT_LIST_MEMBERSAcción

Returns information about members of the workspace.

Parámetros de entrada

org__public__idstring
The unique ID of the Organization to limit the list to.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List milestone epicsSHORTCUT_LIST_MILESTONE_EPICSAcción

(deprecated: use 'list objective epics') list all of the epics within the milestone.

Parámetros de entrada

milestone__public__idintegerObligatorio
The ID of the Milestone.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List milestonesSHORTCUT_LIST_MILESTONESAcción

(deprecated: use 'list objectives') list milestones returns a list of all milestones and their attributes.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List objective epicsSHORTCUT_LIST_OBJECTIVE_EPICSAcción

List all of the epics within the objective.

Parámetros de entrada

objective__public__idintegerObligatorio
The ID of the Objective.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List objectivesSHORTCUT_LIST_OBJECTIVESAcción

List objectives returns a list of all objectives and their attributes.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List projectsSHORTCUT_LIST_PROJECTSAcción

List projects returns a list of all projects and their attributes.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List repositoriesSHORTCUT_LIST_REPOSITORIESAcción

List repositories returns a list of all repositories and their attributes.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List storiesSHORTCUT_LIST_STORIESAcción

List stories returns a list of all stories in a selected project and their attributes.

Parámetros de entrada

project__public__idintegerObligatorio
The unique ID of the Project.
includes_descriptionboolean
A true/false boolean indicating whether to return Stories with their descriptions.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List story commentSHORTCUT_LIST_STORY_COMMENTAcción

Lists comments associated with a story

Parámetros de entrada

story__public__idintegerObligatorio
The ID of the Story that the Comment is in.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List workflowsSHORTCUT_LIST_WORKFLOWSAcción

Returns a list of all workflows in the workspace.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

SearchSHORTCUT_SEARCHAcción

Search lets you search epics and stories based on desired parameters. since ordering of the results can change over time (due to search ranking decay, new epics and stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parámetros de entrada

nextstring
The next page token.
querystringObligatorio
See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
detailstringenum
The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
fullslim
page_sizeinteger
The number of search results to include in a page. Minimum of 1 and maximum of 25.
entity_typesstring[]
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search epicsSHORTCUT_SEARCH_EPICSAcción

Search epics lets you search epics based on desired parameters. since ordering of stories can change over time (due to search ranking decay, new epics being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parámetros de entrada

nextstring
The next page token.
querystringObligatorio
See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
detailstringenum
The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
fullslim
page_sizeinteger
The number of search results to include in a page. Minimum of 1 and maximum of 25.
entity_typesstring[]
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search iterationsSHORTCUT_SEARCH_ITERATIONSAcción

Search iterations lets you search iterations based on desired parameters. since ordering of results can change over time (due to search ranking decay, new iterations being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parámetros de entrada

nextstring
The next page token.
querystringObligatorio
See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
detailstringenum
The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
fullslim
page_sizeinteger
The number of search results to include in a page. Minimum of 1 and maximum of 25.
entity_typesstring[]
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search milestonesSHORTCUT_SEARCH_MILESTONESAcción

Search milestones lets you search milestones based on desired parameters. since ordering of results can change over time (due to search ranking decay, new milestones being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parámetros de entrada

nextstring
The next page token.
querystringObligatorio
See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
detailstringenum
The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
fullslim
page_sizeinteger
The number of search results to include in a page. Minimum of 1 and maximum of 25.
entity_typesstring[]
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search objectivesSHORTCUT_SEARCH_OBJECTIVESAcción

Search objectives lets you search objectives based on desired parameters. since ordering of results can change over time (due to search ranking decay, new objectives being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parámetros de entrada

nextstring
The next page token.
querystringObligatorio
See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
detailstringenum
The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
fullslim
page_sizeinteger
The number of search results to include in a page. Minimum of 1 and maximum of 25.
entity_typesstring[]
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search storiesSHORTCUT_SEARCH_STORIESAcción

Search stories lets you search stories based on desired parameters. since ordering of stories can change over time (due to search ranking decay, new stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parámetros de entrada

nextstring
The next page token.
querystringObligatorio
See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
detailstringenum
The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".
fullslim
page_sizeinteger
The number of search results to include in a page. Minimum of 1 and maximum of 25.
entity_typesstring[]
A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search stories oldSHORTCUT_SEARCH_STORIES_OLDAcción

Search stories lets you search stories based on desired parameters.

Parámetros de entrada

epic_idinteger
The Epic IDs that may be associated with the Stories.
archivedboolean
A true/false boolean indicating whether the Story is in archived state.
epic_idsinteger[]
The Epic IDs that may be associated with the Stories.
estimateinteger
The number of estimate points associate with the Stories.
group_idstringuuid
The Group ID that is associated with the Stories
owner_idstringuuid
An array of UUIDs for any Users who may be Owners of the Stories.
group_idsstring[]
The Group IDs that are associated with the Stories
label_idsinteger[]
The Label IDs that may be associated with the Stories.
owner_idsstring[]
An array of UUIDs for any Users who may be Owners of the Stories.
label_namestring
The name of any associated Labels.
project_idinteger
The IDs for the Projects the Stories may be assigned to.
story_typestringenum
The type of Stories that you want returned.
featurechorebug
external_idstring
An ID or URL that references an external resource. Useful during imports.
project_idsinteger[]
The IDs for the Projects the Stories may be assigned to.
deadline_endstringdate-time
Stories should have a deadline on or before this date.
iteration_idinteger
The Iteration ID that may be associated with the Stories.
iteration_idsinteger[]
The Iteration IDs that may be associated with the Stories.
created_at_endstringdate-time
Stories should have been created on or before this date.
deadline_startstringdate-time
Stories should have a deadline on or after this date.
updated_at_endstringdate-time
Stories should have been updated on or before this date.
requested_by_idstringuuid
The UUID of any Users who may have requested the Stories.
completed_at_endstringdate-time
Stories should have been completed on or before this date.
created_at_startstringdate-time
Stories should have been created on or after this date.
updated_at_startstringdate-time
Stories should have been updated on or after this date.
workflow_state_idinteger
The unique IDs of the specific Workflow States that the Stories should be in.
completed_at_startstringdate-time
Stories should have been completed on or after this date.
includes_descriptionboolean
Whether to include the story description in the response.
workflow_state_typesstring[]
The type of Workflow State the Stories may be in.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Story historySHORTCUT_STORY_HISTORYAcción

Retrieves the complete history of changes for a specific story in the shortcut project management system. this endpoint allows users to track all modifications, updates, and revisions made to a story over time, providing a comprehensive timeline of its evolution. it's particularly useful for project managers, team members, and stakeholders who need to understand how a story has changed, who made the changes, and when they occurred. the endpoint returns a chronological list of all events and modifications associated with the specified story, helping teams maintain transparency and accountability in their project workflows. note that this endpoint focuses solely on the history of a single story and does not provide information about related stories or overall project status.

Parámetros de entrada

story__public__idintegerObligatorio
The ID of the Story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unlink comment thread from slackSHORTCUT_UNLINK_COMMENT_THREAD_FROM_SLACKAcción

Unlinks a comment from its linked slack thread (comment replies and slack replies will no longer be synced)

Parámetros de entrada

story__public__idintegerObligatorio
The ID of the Story to unlink.
comment__public__idintegerObligatorio
The ID of the Comment to unlink.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unlink productboard from epicSHORTCUT_UNLINK_PRODUCTBOARD_FROM_EPICAcción

This endpoint allows you to unlink a productboard epic.

Parámetros de entrada

epic__public__idintegerObligatorio
The unique ID of the Epic.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update categorySHORTCUT_UPDATE_CATEGORYAcción

Update category allows you to replace a category name with another name. if you try to name a category something that already exists, you will receive a 422 response.

Parámetros de entrada

namestring
The new name of the Category.
colorstringcss-color
The hex color to be displayed with the Category (for example, "#ff0000").
archivedboolean
A true/false boolean indicating if the Category has been archived.
category__public__idintegerObligatorio
The unique ID of the Category you wish to update.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update custom fieldSHORTCUT_UPDATE_CUSTOM_FIELDAcción

Update custom field can be used to update the definition of a custom field. the order of items in the 'values' collection is interpreted to be their ascending sort order.to delete an existing enum value, simply omit it from the 'values' collection. new enum values may be created inline by including an object in the 'values' collection having a 'value' entry with no 'id' (eg. {'value': 'mynewvalue', 'color key': 'green'}).

Parámetros de entrada

namestring
A collection of objects representing reporting periods for years.
valuesobject[]
A collection of EnumValue objects representing the values in the domain of some Custom Field.
enabledboolean
Indicates whether the Field is enabled for the Workspace. Only enabled fields can be applied to Stories.
after_idstringuuid
The ID of the CustomField we want to move this CustomField after.
before_idstringuuid
The ID of the CustomField we want to move this CustomField before.
descriptionstring
A description of the purpose of this field.
icon_set_identifierstring
A frontend-controlled string that represents the icon for this custom field.
custom__field__public__idstringObligatorio
The unique ID of the CustomField.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update entity templateSHORTCUT_UPDATE_ENTITY_TEMPLATEAcción

Update an entity template's name or its contents.

Parámetros de entrada

namestring
The updated template name.
story__contents__namestring
The name of the story.
story__contents__tasksobject[]
An array of tasks to be populated by the template.
story__contents__labelsobject[]
An array of labels to be populated by the template.
story__contents__deadlinestringdate-time
The due date of the story.
story__contents__epic__idinteger
The ID of the epic the to be populated.
story__contents__estimateinteger
The numeric point estimate to be populated.
story__contents__file__idsinteger[]
An array of the attached file IDs to be populated.
story__contents__group__idstringuuid
The ID of the group to be populated.
story__contents__owner__idsstring[]
An array of UUIDs of the owners of this story.
entity__template__public__idstringObligatorio
The unique ID of the template to be updated.
story__contents__descriptionstring
The description of the story.
story__contents__project__idinteger
The ID of the project the story belongs to.
story__contents__story__typestring
The type of story (feature, bug, chore).
story__contents__follower__idsstring[]
An array of UUIDs for any Members listed as Followers.
story__contents__iteration__idinteger
The ID of the iteration the to be populated.
story__contents__custom__fieldsobject[]
An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
story__contents__external__linksstring[]
An array of external links to be populated.
story__contents__linked__file__idsinteger[]
An array of the linked file IDs to be populated.
story__contents__workflow__state__idinteger
The ID of the workflow state to be populated.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update epicSHORTCUT_UPDATE_EPICAcción

Update epic can be used to update numerous fields in the epic. the only required parameter is epic id, which can be found in the shortcut ui.

Parámetros de entrada

namestring
The Epic"s name.
statestringenum
`Deprecated` The Epic"s state (to do, in progress, or done); will be ignored when `epic_state_id` is set.
in progressto dodone
labelsobject[]
An array of Labels attached to the Epic.
after_idinteger
The ID of the Epic we want to move this Epic after.
archivedboolean
A true/false boolean indicating whether the Epic is in archived state.
deadlinestringdate-time
The Epic"s deadline.
group_idstringuuid
`Deprecated` The ID of the group to associate with the epic. Use `group_ids`.
before_idinteger
The ID of the Epic we want to move this Epic before.
group_idsstring[]
An array of UUIDS for Groups to which this Epic is related.
owner_idsstring[]
An array of UUIDs for any members you want to add as Owners on this Epic.
descriptionstring
The Epic"s description.
external_idstring
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_idsstring[]
An array of UUIDs for any Members you want to add as Followers on this Epic.
milestone_idinteger
`Deprecated` The ID of the Milestone this Epic is related to. Use `objective_ids`.
epic_state_idinteger
The ID of the Epic State.
objective_idsinteger[]
An array of IDs for Objectives to which this Epic is related.
requested_by_idstringuuid
The ID of the member that requested the epic.
epic__public__idintegerObligatorio
The unique ID of the Epic.
planned_start_datestringdate-time
The Epic"s planned start date.
started_at_overridestringdate-time
A manual override for the time/date the Epic was started.
completed_at_overridestringdate-time
A manual override for the time/date the Epic was completed.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update epic commentSHORTCUT_UPDATE_EPIC_COMMENTAcción

This endpoint allows you to update a threaded comment on an epic.

Parámetros de entrada

textstringObligatorio
The updated comment text.
epic__public__idintegerObligatorio
The ID of the associated Epic.
comment__public__idintegerObligatorio
The ID of the Comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update fileSHORTCUT_UPDATE_FILEAcción

Update file updates the properties of an uploadedfile (but not its content).

Parámetros de entrada

namestring
The name of the file.
created_atstringdate-time
The time/date that the file was uploaded.
updated_atstringdate-time
The time/date that the file was last updated.
descriptionstring
The description of the file.
external_idstring
An additional ID that you may wish to assign to the file.
uploader_idstringuuid
The unique ID assigned to the Member who uploaded the file to Shortcut.
file__public__idintegerObligatorio
The unique ID assigned to the file in Shortcut.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update groupSHORTCUT_UPDATE_GROUPAcción

Updates an existing group in the shortcut workspace. this endpoint allows you to modify various properties of a group, including its name, description, color, members, and associated workflows. use this when you need to change group details, add or remove members, or update the group's visual representation. it's particularly useful for team reorganizations, project changes, or general maintenance of your shortcut workspace structure. note that while many fields are optional, you should include any fields you wish to modify; omitted fields will retain their current values.

Parámetros de entrada

namestring
The name of this Group.
colorstringcss-color
The color you wish to use for the Group in the system.
archivedboolean
Whether or not this Group is archived.
color_keystringenum
The color key you wish to use for the Group in the system.
bluepurplemidnight-blueorangeyellow-greenbrassgrayfuchsiayellowpinksky-bluegreen+4
member_idsstring[]
The Member ids to add to this Group.
descriptionstring
The description of this Group.
mention_namestring
The mention name of this Group.
workflow_idsinteger[]
The Workflow ids to add to the Group.
display_icon_idstringuuid
The Icon id for the avatar of this Group.
group__public__idstringObligatorio
The unique ID of the Group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update iterationSHORTCUT_UPDATE_ITERATIONAcción

This endpoint allows you to update an existing iteration in shortcut. it provides comprehensive control over various aspects of an iteration, including its metadata, associated members and groups, labels, and timeframe. use this endpoint when you need to modify any details of an ongoing or upcoming iteration, such as adjusting dates, adding followers, or updating labels. the endpoint is particularly useful for project managers or team leads who need to refine iteration details as the project progresses. note that while you can update multiple aspects of an iteration in a single call, only the fields you include in the request will be modified; omitted fields will retain their current values.

Parámetros de entrada

namestring
The name of this Iteration
labelsobject[]
An array of Labels attached to the Iteration.
end_datestring
The date this Iteration ends, e.g. 2019-07-05.
group_idsstring[]
An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI.
start_datestring
The date this Iteration begins, e.g. 2019-07-01
descriptionstring
The description of the Iteration.
follower_idsstring[]
An array of UUIDs for any Members you want to add as Followers.
iteration__public__idintegerObligatorio
The unique ID of the Iteration.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update key resultSHORTCUT_UPDATE_KEY_RESULTAcción

Update key result allows updating a key result's name or initial, observed, or target values.

Parámetros de entrada

namestring
The name of the Key Result.
key__result__public__idstringObligatorio
The ID of the Key Result.
target__value__boolean__valueboolean
The boolean value.
target__value__numeric__valuestring
The numeric value, as a decimal string. No more than two decimal places are allowed.
observed__value__boolean__valueboolean
The boolean value.
observed__value__numeric__valuestring
The numeric value, as a decimal string. No more than two decimal places are allowed.
initial__observed__value__boolean__valueboolean
The boolean value.
initial__observed__value__numeric__valuestring
The numeric value, as a decimal string. No more than two decimal places are allowed.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update labelSHORTCUT_UPDATE_LABELAcción

Update label allows you to replace a label name with another name. if you try to name a label something that already exists, you will receive a 422 response.

Parámetros de entrada

namestring
The new name of the label.
colorstringcss-color
The hex color to be displayed with the Label (for example, "#ff0000").
archivedboolean
A true/false boolean indicating if the Label has been archived.
descriptionstring
The new description of the label.
label__public__idintegerObligatorio
The unique ID of the Label you wish to update.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update linked fileSHORTCUT_UPDATE_LINKED_FILEAcción

Updated linked file allows you to update properties of a previously attached linked-file.

Parámetros de entrada

urlstring
The URL of linked file.
namestring
The name of the file.
sizeinteger
The filesize, if the integration provided it.
typestringenum
The integration type of the file (e.g. google, dropbox, box).
googleurldropboxboxonedrive
story_idinteger
The ID of the linked story.
descriptionstring
The description of the file.
uploader_idstringuuid
The UUID of the member that uploaded the file.
thumbnail_urlstring
The URL of the thumbnail, if the integration provided it.
linked__file__public__idintegerObligatorio
The unique identifier of the linked file.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update milestoneSHORTCUT_UPDATE_MILESTONEAcción

(deprecated: use 'update objective') update milestone can be used to update milestone properties.

Parámetros de entrada

namestring
The name of the Milestone.
statestringenum
The workflow state that the Milestone is in.
in progressto dodone
after_idinteger
The ID of the Milestone we want to move this Milestone after.
archivedboolean
A boolean indicating whether the Milestone is archived or not
before_idinteger
The ID of the Milestone we want to move this Milestone before.
categoriesobject[]
An array of IDs of Categories attached to the Milestone.
descriptionstring
The Milestone"s description.
started_at_overridestringdate-time
A manual override for the time/date the Milestone was started.
completed_at_overridestringdate-time
A manual override for the time/date the Milestone was completed.
milestone__public__idintegerObligatorio
The ID of the Milestone.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update multiple storiesSHORTCUT_UPDATE_MULTIPLE_STORIESAcción

Update multiple stories allows you to make changes to numerous stories at once.

Parámetros de entrada

epic_idinteger
The ID of the epic the story belongs to.
move_tostringenum
One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.
lastfirst
after_idinteger
The ID of the story that the stories are to be moved below.
archivedboolean
If the Stories should be archived or not.
deadlinestringdate-time
The due date of the story.
estimateinteger
The numeric point estimate of the story. Can also be null, which means unestimated.
group_idstringuuid
The Id of the Group the Stories should belong to.
before_idinteger
The ID of the story that the stories are to be moved before.
story_idsinteger[]Obligatorio
The Ids of the Stories you wish to update.
labels_addobject[]
An array of labels to be added.
project_idinteger
The ID of the Project the Stories should belong to.
story_typestringenum
The type of story (feature, bug, chore).
featurechorebug
iteration_idinteger
The ID of the iteration the story belongs to.
labels_removeobject[]
An array of labels to be removed.
owner_ids_addstring[]
The UUIDs of the new owners to be added.
external_linksstring[]
An array of External Links associated with this story.
requested_by_idstringuuid
The ID of the member that requested the story.
follower_ids_addstring[]
The UUIDs of the new followers to be added.
owner_ids_removestring[]
The UUIDs of the owners to be removed.
custom_fields_addobject[]
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
workflow_state_idinteger
The ID of the workflow state to put the stories in.
follower_ids_removestring[]
The UUIDs of the followers to be removed.
custom_fields_removeobject[]
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update objectiveSHORTCUT_UPDATE_OBJECTIVEAcción

Update objective can be used to update objective properties.

Parámetros de entrada

namestring
The name of the Objective.
statestringenum
The workflow state that the Objective is in.
in progressto dodone
after_idinteger
The ID of the Objective we want to move this Objective after.
archivedboolean
A boolean indicating whether the Objective is archived or not
before_idinteger
The ID of the Objective we want to move this Objective before.
categoriesobject[]
An array of IDs of Categories attached to the Objective.
descriptionstring
The Objective"s description.
started_at_overridestringdate-time
A manual override for the time/date the Objective was started.
completed_at_overridestringdate-time
A manual override for the time/date the Objective was completed.
objective__public__idintegerObligatorio
The ID of the Objective.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update projectSHORTCUT_UPDATE_PROJECTAcción

Update project can be used to change properties of a project.

Parámetros de entrada

namestring
The Project"s name.
colorstringcss-color
The color that represents the Project in the UI.
team_idinteger
The ID of the team the project belongs to.
archivedboolean
A true/false boolean indicating whether the Story is in archived state.
descriptionstring
The Project"s description.
abbreviationstring
The Project abbreviation used in Story summaries. Should be kept to 3 characters at most.
follower_idsstring[]
An array of UUIDs for any Members you want to add as Followers.
show_thermometerboolean
Configuration to enable or disable thermometers in the Story summary.
days_to_thermometerinteger
The number of days before the thermometer appears in the Story summary.
project__public__idintegerObligatorio
The unique ID of the Project.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update storySHORTCUT_UPDATE_STORYAcción

Update story can be used to update story properties.

Parámetros de entrada

namestring
The title of the story.
labelsobject[]
An array of labels attached to the story.
epic_idinteger
The ID of the epic the story belongs to.
move_tostringenum
One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.
lastfirst
after_idinteger
The ID of the story we want to move this story after.
archivedboolean
True if the story is archived, otherwise false.
deadlinestringdate-time
The due date of the story.
estimateinteger
The numeric point estimate of the story. Can also be null, which means unestimated.
file_idsinteger[]
An array of IDs of files attached to the story.
group_idstringuuid
The ID of the group to associate with this story
before_idinteger
The ID of the story we want to move this story before.
owner_idsstring[]
An array of UUIDs of the owners of this story.
branch_idsinteger[]
An array of IDs of Branches attached to the story.
commit_idsinteger[]
An array of IDs of Commits attached to the story.
project_idinteger
The ID of the project the story belongs to.
story_typestringenum
The type of story (feature, bug, chore).
featurechorebug
descriptionstring
The description of the story.
follower_idsstring[]
An array of UUIDs of the followers of this story.
iteration_idinteger
The ID of the iteration the story belongs to.
custom_fieldsobject[]
A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.
external_linksstring[]
An array of External Links associated with this story.
linked_file_idsinteger[]
An array of IDs of linked files attached to the story.
requested_by_idstringuuid
The ID of the member that requested the story.
pull_request_idsinteger[]
An array of IDs of Pull/Merge Requests attached to the story.
story__public__idintegerObligatorio
The unique identifier of this story.
workflow_state_idinteger
The ID of the workflow state to put the story in.
started_at_overridestringdate-time
A manual override for the time/date the Story was started.
completed_at_overridestringdate-time
A manual override for the time/date the Story was completed.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update story commentSHORTCUT_UPDATE_STORY_COMMENTAcción

Update comment replaces the text of the existing comment.

Parámetros de entrada

textstringObligatorio
The updated comment text.
story__public__idintegerObligatorio
The ID of the Story that the Comment is in.
comment__public__idintegerObligatorio
The ID of the Comment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update story linkSHORTCUT_UPDATE_STORY_LINKAcción

Updates the stories and/or the relationship for the given story link.

Parámetros de entrada

verbstringenum
The type of link.
blocksduplicatesrelates to
object_idinteger
The ID of the object Story.
subject_idinteger
The ID of the subject Story.
story__link__public__idintegerObligatorio
The unique ID of the Story Link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update taskSHORTCUT_UPDATE_TASKAcción

Update task can be used to update task properties.

Parámetros de entrada

after_idinteger
Move task after this task ID.
completeboolean
A true/false boolean indicating whether the task is complete.
before_idinteger
Move task before this task ID.
owner_idsstring[]
An array of UUIDs of the owners of this story.
descriptionstring
The Task"s description.
task__public__idintegerObligatorio
The unique identifier of the Task you wish to update.
story__public__idintegerObligatorio
The unique identifier of the parent Story.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload filesSHORTCUT_UPLOAD_FILESAcción

Upload files uploads one or many files and optionally associates them with a story. use the multipart/form-data content-type to upload. each `file` key should contain a separate file. each uploadedfile's name comes from the content-disposition header "filename" directive for that field.

Parámetros de entrada

file0objectbinary
File0
file1objectbinary
File1
file2objectbinary
File2
file3objectbinary
File3
story_idobject
Story Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not