Shortcut integration

Get category

Get category returns information about the selected category.

Get current member info

Returns information about the authenticated member.

Get custom field

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.

Get entity template

Get entity template returns information about a given entity template.

Get epic

Get epic returns information about the selected epic.

Get epic comment

This endpoint returns information about the selected epic comment.

Get epic workflow

Returns the epic workflow for the workspace.

Get external link stories

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

Get file

Get file returns information about the selected uploadedfile.

Get group

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.

Get iteration

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.

Get key result

Get key result returns information about a chosen key result.

Create category

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

Create entity template

Create a new entity template for the workspace.

Create epic

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

Create epic comment

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

Create epic comment comment

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

Create group

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.

Create iteration

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.

Create label

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

Create linked file

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

Create milestone

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

Create multiple stories

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).

Create objective

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