Create a shortcut
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.
Authentication
AuthorizationBearer
OAuth authentication of the form <token>.
Request
The request body.
parentId
The ID of the folder or workspace to place the shortcut in.
target
The item the shortcut points to.
name
A name for the shortcut. Defaults to the name of the item it points to if this field is omitted.
Response
The response body.
id
urlId
name
parentId
parentUrlId
path
target
createdBy
The identifier of the user who created this object.
updatedBy
The identifier of the user or process that last updated this object.
createdAt
When the object was created.
updatedAt
When the object was last updated.
ownerId

