---
title: "List Shares"
method: GET
path: "/shares"
tags: ["Shares"]
---

# List Shares

`GET /shares`

## Request

- Base URL: `https://api.aspect.inc`
- URL: `https://api.aspect.inc/shares`
- Auth: API key in header `Authorization`

List all shares for a resource (requires FULL_ACCESS)

## Query parameters

- `resource_id` string, uuid, required: Resource id being shared (collection, directory, asset)

## Response `200`

Successful Response

- ShareListResponse: API response schema for listing shares
  - `shares` ShareResponse[], required: List of shares
    - `id` string, uuid, required: Share ID (used in URLs)
    - `resource_id` string, uuid, required: Resource being shared
    - `resource_type` 'workspace' | 'project' | 'directory' | 'asset' | 'symlink' | 'collection' | 'canvas', required: Types of resources in the hierarchy.
    - `resource_name` string, required: Name of the resource
    - `created_by_user_id` string, uuid, nullable: User who created the share. Null when that account has been deleted
    - `name` string, nullable: Share name
    - `actions` integer, required: Allowed actions bitmap
    - `has_password` boolean, required: Whether share is password protected
    - `expires_at` string, date-time, nullable: Expiration timestamp
    - `is_active` boolean, required: Whether the share is active
    - `watermark_id` string, uuid, nullable: Watermark configuration applied to share viewers
    - `visible_metadata_attribute_ids` string[], nullable: Metadata attribute IDs share users can see
    - `created` string, date-time, required: Creation timestamp
    - `updated` string, date-time, required: Last update timestamp
  - `total` integer, required: Total number of shares for the resource

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/aspect/apis/aspect-api.md) - [All operations](https://skmtc.dev/aspect/apis/aspect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aspect/apis/aspect-api/revisions/28ea5f1adb54?raw)