---
title: "Create a shortcut"
method: POST
path: "/v2/shortcuts"
tags: ["shortcuts"]
---

# Create a shortcut

`POST /v2/shortcuts`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/shortcuts`
- Auth: HTTP bearer

Create a shortcut that surfaces an existing item in another folder or workspace without duplicating it.

  ### Usage notes
  - A shortcut requires a **parentId** (the folder or workspace to place it in) and a **target** (the item the shortcut points to).
    - Retrieve the ID of a folder to use as a **parentId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.
    - Retrieve the ID of a workspace to use as a **parentId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.
  - The target can be a document (workbook, data model, report, dataset, or folder) or a database object (table, view, schema, database, or stored procedure).
  - You must have at least **Can view** access to the target document or folder, or **Can use** access to the target database object.

  ### Usage scenarios
  - **Deployment and embedding**: Surface shared workbooks or data models in tenant workspaces or folders without exposing a central workspace to end users.

## Request body

- object
  - `parentId` string, required: The ID of the folder or workspace to place the shortcut in.
  - `target` V2ShortcutsPostRequestBodyContentApplicationJsonSchemaTarget, required: The item the shortcut points to.
    - `id` string, required: The ID of the workbook, data model, report, dataset, folder, or database object the shortcut points to.
  - `name` string: A name for the shortcut. Defaults to the name of the item it points to if this field is omitted.

## Response `200`

The response body.

- ShortcutsCreateResponse200
  - `id` string, required
  - `urlId` string, required
  - `name` string, required
  - `parentId` string, required
  - `parentUrlId` string, required
  - `path` string, required
  - `target` V2ShortcutsPostResponsesContentApplicationJsonSchemaTarget, required
    - `type` 'workbook' | 'data-model' | 'dataset' | 'report' | 'folder' | 'table' | 'scope' | 'stored-procedure', required: The type of the item this shortcut points to. For database targets, `table` also covers views, and `scope` covers schemas and databases.
    - `id` string, required: The ID of the item this shortcut points to.
  - `ownerId` string, nullable
  - `createdBy` string, required: The identifier of the user who created this object.
  - `updatedBy` string, required: The identifier of the user or process that last updated this object.
  - `createdAt` string, date-time, required: When the object was created.
  - `updatedAt` string, date-time, required: When the object was last updated.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)