We know your data needs to move with you, from Shortcut and into Shortcut, to keep up with the speed of success within your team. To help, we've created several ways that you can both import and export data from and to Shortcut.
Importing Data
Are you looking to bring data into Shortcut? We have several options to make the process as painless as possible for your team - you can use our importers for either Jira or Trello, import by providing our friendly Support team a CSV file, or even utilize our API v3 to add data directly into your Shortcut instance.
- Moving to Shortcut from Trello? Bring your team and data over easily by letting us assist. Our automatic importer was made here in-house to help our users move their most valuable work into Shortcut where you and your team can pick up conversations exactly where you left off.
Ready to begin? See our Trello Import installation article for detailed information and a handy video guide - Our Jira importer was made here in-house to help our users fully move their Jira projects into Shortcut where you and your team can pick up conversations exactly where you left off. Get started now with the Import Data from Jira Guide.
Alternatively, not quite ready to move off Jira yet? Give our Jira Sync tool a try! With this tool, you can sync your Jira workspace in real-time in order to better trial Shortcut. Check our Jira Sync Guide. - Export your data from your existing Tool to CSV, and enter this into a CSV file for Shortcut to import!
Check out our CSV import guide on how to start the CSV import process. - Looking for a more advanced way to bring your data into Shortcut? Our REST API (v3) can help!
Check out our API documentation here for creating Stories, Epics, Objectives, Projects, Groups and more, as well as other helpful functionality.
Exporting Data
Shortcut works best when it integrates into the tools your team uses the most. For teams looking to build out powerful custom reporting, automated workflows, or create backups of their data, we offer the convenience of exporting your data in either CSV or JSON in many places around Shortcut.
CSV Exports
Look for the "Export as CSV" prompt to export all of the Stories from a single Workspace, Iteration, Epic, Label, or Project.
- To Export all Stories in a Workspace as CSV, that option is located on your Organization and Workspace dashboard.
- If seeking to export a CSV of a specific set of Stories, such as from an Epic, Iteration, or Label for example, that Export as CSV option is located in the top right of the Stories Table.
- To export a filtered Space on the new Stories page, the Export option is within the dropdown for that Space.
All exports include the following information about each Story:
| Column | Description |
|---|---|
| id | Story ID |
| name | Story Name |
| type | Story Type |
| requester | Story Requester |
| owners | A list of Story Owners, if assigned |
| description | Story Description |
| is_completed | TRUE/FALSE boolean noting if a Story has been Completed |
| created_at | The date and time the Story was created |
| started_at | The date and time the Story was moved to a Started state |
| updated_at | The date and time of the last update to the Story |
| moved_at | The date and time that the Story last changed states |
| completed_at | The date and time the Story was moved to a Completed state |
| estimate | Estimate points for the Story, if assigned |
| external_ticket_count | Number of attached external tickets |
| external_tickets | The URLs of the attached external tickets |
| is_blocked | TRUE/FALSE boolean noting if a Story is blocked by another Story |
| is_a_blocker | TRUE/FALSE boolean noting if a Story blocks another Story |
| due_date | The due date of the Story |
| labels | List of Labels applied to the Story. *Note* These are only Story Labels. Epic Labels will not be displayed in this list. |
| epic_labels | List of Epic Labels for the Epic a Story is associated with. |
| tasks |
List of Tasks in a Story. Completion is marked with an X, and the Task owner (if assigned) is included. |
| state | Workflow state of the Story when the download was initiated |
| epic_id | ID of Epic the Story is in (if any) |
| epic | Epic Name |
| epic_label | Epic labels that are linked to the story |
| project_id | ID of the Project the Story is in |
| project | Project Name |
| iteration_id | ID of the Iteration that the Story belongs to, if it belongs to one |
| iteration | Name of the Iteration that the Story belongs to, if it belongs to one |
| utc_offset |
The user's UTC offset, which affects the times displayed (this is different than the Organization UTC offset) |
| is_archived |
TRUE/FALSE boolean noting if a Story has been archived |
| team_id |
Team ID for the Team that is associated with the Story |
| team |
Team name that is associated with the Story |
| epic_state | Workflow State of the Epic |
| epic_is_archived | TRUE/FALSE boolean noting if an Epic has or has not been archived |
| epic_started_at | The date and time the Epic was moved to a Started state |
| epic_due_date | The due date of the Epic |
| epic_created_at | The date and time the Epic was created |
| objective_id | ID of the Objective |
| objective | Name of the Objective |
| objective_state | Workflow State of the Objective |
| objective_created_at | The date and time the Objective was created |
| objective_started_at | The date and time the Objective was moved to a Started state |
| objective_due_date | The due date of the Objective |
|
objective_categories |
The categories created an Objective |
|
epic_planned_start_date |
The Start Date set for an Epic |
|
workflow |
The name of the Workflow that a Story is in |
|
workflow_id |
Public ID of the Story's Workflow |
|
priority |
The Priority Field values associated with a Story |
|
severity |
The Severity Field values associated with a Story |
|
product_area |
The Product Area Field values associated with a Story |
|
skill_set |
The Skill Set Field values associated with a Story |
|
technical_area |
The Technical Area Field values associated with a Story |
|
custom_fields |
The Advanced Custom Field Values associated with a Story |
We do not support exporting Docs in the UI or via the API, nor are Story comments and attached files included as part of the CSV at this time. If seeking to gather comments or file data, see our API Tips, Tricks, & Workarounds.
JSON Exports
You can use the Shortcut Exporter to export all of your Shortcut organization data to JSON files, which you can use to transfer your data to another system, maintain backups, or simply for data analysis.
- Download and install cURL (if you don't have it already).
- Navigate to Settings > My Account > API Tokens in Shortcut and generate an environment-specific token.
- Download the Shortcut Exporter shell script here. Be sure to use the correct script for your operating system.
- In your command line interface, set your API token as an environment variable.
- Run the Exporter script in your command line interface.
Please note the exporter does not include full entities for Story descriptions, comments, branches, commits, files, linked-files, and Tasks. To obtain these full entities, including Story descriptions, use our API's Get Story endpoint in subsequent requests.
Updated