> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Shortcut

## Overview

<CardGroup cols={3}>
  <Card title="Pre-built tooling" icon="screwdriver-wrench" href="#pre-built-tooling" />

  <Card title="Pre-built integrations" icon="square-check" href="#pre-built-integrations" />

  <Card title="Access requirements" icon="triangle-exclamation" href="#access-requirements" />

  <Card title="Setup guide" icon="rocket" href="#setup-guide" />

  <Card title="Useful links" icon="circle-info" href="#useful-links" />

  <Card title="API gotchas" icon="biohazard" href="#api-gotchas" />
</CardGroup>

## Pre-built tooling

<AccordionGroup>
  <Accordion title="✅ Authorization">
    | Tools                             | Status |
    | --------------------------------- | ------ |
    | Pre-built authorization (API Key) | ✅      |
    | Pre-built authorization UI        | ✅      |
    | Custom authorization UI           | ✅      |
    | End-user authorization guide      | 🚫     |
    | Expired credentials detection     | ✅      |
  </Accordion>

  <Accordion title="✅ Read & write data">
    | Tools                                     | Status                         |
    | ----------------------------------------- | ------------------------------ |
    | Pre-built integrations                    | ✅                              |
    | API unification                           | ✅                              |
    | 2-way sync                                | ✅                              |
    | Webhooks from Nango on data modifications | ✅                              |
    | Real-time webhooks from 3rd-party API     | 🚫 (time to contribute: \<48h) |
    | Proxy requests                            | ✅                              |
  </Accordion>

  <Accordion title="✅ Observability & data quality">
    | Tools                   | Status |
    | ----------------------- | ------ |
    | HTTP request logging    | ✅      |
    | End-to-end type safety  | ✅      |
    | Data runtime validation | ✅      |
    | OpenTelemetry export    | ✅      |
    | Slack alerts on errors  | ✅      |
    | Integration status API  | ✅      |
  </Accordion>

  <Accordion title="✅ Customization">
    | Tools                              | Status                         |
    | ---------------------------------- | ------------------------------ |
    | Create or customize use-cases      | ✅                              |
    | Pre-configured pagination          | 🚫 (time to contribute: \<48h) |
    | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
    | Per-customer configurations        | ✅                              |
  </Accordion>
</AccordionGroup>

### Others

| Function name          | Description                                                                                               | Type                                           | Source code                                                                                                                   |
| ---------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `create-category`      | Create a category.                                                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-category.ts)      |
| `create-custom-field`  | Create a workspace custom field.                                                                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-custom-field.ts)  |
| `create-epic-comment`  | Add a comment to an epic.                                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-epic-comment.ts)  |
| `create-epic`          | Create an epic.                                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-epic.ts)          |
| `create-iteration`     | Create an iteration.                                                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-iteration.ts)     |
| `create-label`         | Create a label.                                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-label.ts)         |
| `create-linked-file`   | Attach a URL-based linked file. Associate it with stories afterward via update-story's linked\_file\_ids. | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-linked-file.ts)   |
| `create-milestone`     | Create an Objective.                                                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-milestone.ts)     |
| `create-story-comment` | Add a comment to a story.                                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-story-comment.ts) |
| `create-story-link`    | Link two stories with a relationship verb (blocks, duplicates, relates to).                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-story-link.ts)    |
| `create-story-task`    | Add a checklist task to a story                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-story-task.ts)    |
| `create-story`         | Create a story.                                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/create-story.ts)         |
| `delete-category`      | Delete a category.                                                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-category.ts)      |
| `delete-custom-field`  | Delete a workspace custom field.                                                                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-custom-field.ts)  |
| `delete-epic`          | Delete an epic.                                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-epic.ts)          |
| `delete-iteration`     | Delete an iteration.                                                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-iteration.ts)     |
| `delete-label`         | Delete a label                                                                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-label.ts)         |
| `delete-linked-file`   | Delete a linked file.                                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-linked-file.ts)   |
| `delete-milestone`     | Delete an Objective                                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-milestone.ts)     |
| `delete-story-comment` | Delete a comment from a story.                                                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-story-comment.ts) |
| `delete-story-link`    | Remove a link between two stories.                                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-story-link.ts)    |
| `delete-story-task`    | Delete a task from a story.                                                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-story-task.ts)    |
| `delete-story`         | Delete a story.                                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/delete-story.ts)         |
| `get-current-member`   | Get the authenticated member and their workspace context.                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/get-current-member.ts)   |
| `get-epic`             | Retrieve a single epic.                                                                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/get-epic.ts)             |
| `get-story-task`       | Retrieve a single task on a story.                                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/get-story-task.ts)       |
| `get-story`            | Retrieve a single story with its embedded comments, tasks, and links.                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/get-story.ts)            |
| `list-categories`      | List categories (used to group Objectives/Milestones).                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-categories.ts)      |
| `list-custom-fields`   | List workspace custom fields available on stories.                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-custom-fields.ts)   |
| `list-epics`           | List epics.                                                                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-epics.ts)           |
| `list-groups`          | List groups (the modern Team concept).                                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-groups.ts)          |
| `list-iterations`      | List iterations (sprints).                                                                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-iterations.ts)      |
| `list-labels`          | List labels.                                                                                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-labels.ts)          |
| `list-linked-files`    | List linked (URL-based) files.                                                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-linked-files.ts)    |
| `list-members`         | List workspace members.                                                                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-members.ts)         |
| `list-milestones`      | List Objectives (called milestones in the Shortcut API).                                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-milestones.ts)      |
| `list-projects`        | List projects — a deprecated, pre-Epics/Groups feature.                                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-projects.ts)        |
| `list-stories`         | Search/list stories with rich filters.                                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-stories.ts)         |
| `list-workflows`       | List story workflows and their states.                                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/list-workflows.ts)       |
| `update-epic`          | Update an epic.                                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/update-epic.ts)          |
| `update-iteration`     | Update an iteration.                                                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/update-iteration.ts)     |
| `update-label`         | Update a label.                                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/update-label.ts)         |
| `update-milestone`     | Update an Objective.                                                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/update-milestone.ts)     |
| `update-story-task`    | Update or complete a task on a story.                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/update-story-task.ts)    |
| `update-story`         | Update a story.                                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/actions/update-story.ts)         |
| `categories`           | Sync categories (used to group Objectives).                                                               | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/categories.ts)             |
| `custom-fields`        | Sync workspace custom field definitions.                                                                  | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/custom-fields.ts)          |
| `epics`                | Sync epics.                                                                                               | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/epics.ts)                  |
| `groups`               | Sync groups.                                                                                              | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/groups.ts)                 |
| `iterations`           | Sync iterations.                                                                                          | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/iterations.ts)             |
| `labels`               | Sync labels.                                                                                              | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/labels.ts)                 |
| `members`              | Sync workspace members.                                                                                   | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/members.ts)                |
| `milestones`           | Sync Objectives (API resource name is milestone).                                                         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/milestones.ts)             |
| `projects`             | Sync projects (legacy feature).                                                                           | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/projects.ts)               |
| `stories`              | Sync stories.                                                                                             | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/stories.ts)                |
| `workflows`            | Sync story workflows and their states.                                                                    | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/shortcut/syncs/workflows.ts)              |

## Access requirements

| Pre-Requisites    | Status | Comment |
| ----------------- | ------ | ------- |
| Paid dev account  | ❓      |         |
| Paid test account | ❓      |         |
| Partnership       | ❓      |         |
| App review        | ❓      |         |
| Security audit    | ❓      |         |

## Setup guide

*No setup guide yet.*

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/shortcut.mdx)</Note>

## Useful links

* [How to find API credentials (for end-users)](https://app.shortcut.com/settings/account/api-tokens)
* [Auth docs](https://developer.shortcut.com/api/rest/v3#Authentication)
* [Web API docs (their REST API)](https://developer.shortcut.com/api/rest/v3)

<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/shortcut.mdx)</Note>

## API gotchas

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/shortcut.mdx)</Note>