---
title: "Get Shared Link"
method: GET
path: "/file-storage/shared-links/{id}"
tags: ["Shared Links"]
---

# Get Shared Link

`GET /file-storage/shared-links/{id}`

Get Shared Link

## Path parameters

- `id` string, required

## Query parameters

- `raw` boolean
- `fields` string, nullable

## Headers

- `x-apideck-consumer-id` string, required
- `x-apideck-app-id` string, required
- `x-apideck-service-id` string

## Response `200`

Shared Link

- GetSharedLinkResponse
  - `status_code` integer, required — HTTP Response Status Code
  - `status` string, required — HTTP Response Status
  - `service` string, required — Apideck ID of service provider
  - `resource` string, required — Unified API resource name
  - `operation` string, required — Operation performed
  - `data` SharedLink, required
    - `url` string, nullable — The URL that can be used to view the file.
    - `download_url` string, nullable — The URL that can be used to download the file.
    - `target_id` string, nullable, required — The ID of the file or folder to link.
    - `target` SharedLinkTarget
      - `id` string, required — A unique identifier for an object.
      - `name` string, nullable — The name of the file
      - `type` 'file' | 'folder' | 'url', nullable — The type of resource. Could be file, folder or url
    - `scope` 'public' | 'company', nullable — The scope of the shared link.
    - `password_protected` boolean, nullable — Indicated if the shared link is password protected.
    - `password` string, nullable — Optional password for the shared link.
    - `expires_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable — The date and time when the object was last updated.
    - `created_at` string, date-time, nullable — The date and time when the object was created.
    - `pass_through` object[] — The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
      - `service_id` string, required — Identifier for the service to which this pass_through should be applied.
      - `operation_id` string — Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request.
      - `extend_object` object — Simple object allowing any properties for direct extension.
      - `extend_paths` object[] — Array of objects for structured data modifications via paths.
        - `path` string, required — JSONPath string specifying where to apply the value.
        - `value` unknown, required
  - `meta` Meta — Response metadata
    - `items_on_page` integer — Number of items returned in the data property of the response
    - `cursors` object — Cursors to navigate to previous or next pages through the API
      - `previous` string, nullable — Cursor to navigate to the previous page of results through the API
      - `current` string, nullable — Cursor to navigate to the current page of results through the API
      - `next` string, nullable — Cursor to navigate to the next page of results through the API
    - `total_count` integer — Number of records available in total for this resource
    - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200.
      - `type` string — Discriminator for the warning kind.
      - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available.
      - `error` string, nullable — Short error description from the downstream provider, when available.
      - `operation` string, nullable — Identifier of the workflow step that failed.
      - `message` string, nullable — Detailed message from the downstream provider, when available.
  - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `404` — The specified resource was not found
- `422` — Unprocessable
- `default` — Unexpected error

---

[API](https://skmtc.dev/apideck-libraries/apis/file-storage-api.md) · [All operations](https://skmtc.dev/apideck-libraries/apis/file-storage-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apideck-libraries/file-storage-api/revisions/2d44271f3bdd/schema)