---
title: "Get a list of all domain shares"
method: GET
path: "/v1/shares/all/"
---

# Get a list of all domain shares

`GET /v1/shares/all/`

## Request

- Base URL: `https://app.iconik.io/API/assets`
- URL: `https://app.iconik.io/API/assets/v1/shares/all/`
- Auth: none declared. Required headers: `App-ID`, `Auth-Token`
- TypeScript: <https://skmtc.dev/iconik/apis/iconik-assets/docs/v1/shares/all/get.ts> (a function with typed inputs; its response is checked against the schema)

Required roles:
 - can_manage_all_shares

## Query parameters

- `title` string
- `object_type` string
- `object_id` string
- `owner_id` string
- `member_id` string
- `ids` string
- `query` string
- `_exists_` string
- `date_created` string
- `date_modified` string
- `expires` string
- `starts` string
- `schedule_status` string
- `page` integer
- `per_page` integer
- `scroll` boolean
- `scroll_id` string
- `sort` string
- `include_automatic_approval_share` boolean

## Headers

- `App-ID` string, required
- `Auth-Token` string, required

## Response `200`

Returns a list of shares

- SharesElasticSchema
  - `facets` object
  - `first_url` string
  - `last_url` string
  - `next_url` string
  - `objects` ShareElasticSchema[]
    - `allow_approving_comments` boolean, required
    - `allow_comments` boolean, required
    - `allow_custom_actions` boolean
    - `allow_download` boolean, required
    - `allow_download_proxy` boolean
    - `allow_setting_approve_status` boolean, required
    - `allow_sync` boolean, nullable
    - `allow_upload` boolean
    - `allow_user_search_for_mentions` boolean
    - `allow_view_transcriptions` boolean
    - `allow_view_versions` boolean
    - `approval` object
    - `automatic_approval_share` boolean
    - `date_created` string, date-time
    - `drm` 'none' | 'standard', nullable: DRM settings for the share
    - `expires` string, date-time
    - `has_password` boolean
    - `id` string
    - `is_approval` boolean
    - `message` string, nullable
    - `metadata_views` string[], nullable
    - `object_id` string
    - `object_title` string
    - `object_type` string
    - `owner_id` string
    - `personal_url` string
    - `population_status` 'POPULATING' | 'FINISHED'
    - `project_id` string, uuid, nullable: Project ID if the share is created from a project
    - `review_experience_public_beta` boolean, nullable
    - `schedule_status` 'SCHEDULED' | 'ACTIVE' | 'EXPIRED': Derived from starts and expires
    - `show_existing_comments` boolean, nullable
    - `show_watermark` boolean, nullable
    - `starts` string, date-time, nullable: Date and time the share is scheduled to start (the embargo date)
    - `system_domain_id` string
    - `title` string, nullable
    - `upload_storage_id` string, uuid, nullable
    - `url` string
    - `users` ShareUsersElastic[]
      - `access_count` integer
      - `download_count` integer
      - `email` string, email
      - `id` string, uuid
      - `last_access_date` string, date-time
    - `watermark` 'none' | 'standard', nullable: Watermark settings for the share
  - `page` integer
  - `pages` integer
  - `per_page` integer
  - `prev_url` string
  - `scroll_id` string
  - `search_after` unknown[]
    - unknown
  - `total` integer

## Other responses

- `400`: Bad request
- `401`: Token is invalid
- `404`: Requested page does not exist
- `default`: Error response

---

[API](https://skmtc.dev/iconik/apis/iconik-assets.md) - [All operations](https://skmtc.dev/iconik/apis/iconik-assets/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/iconik-assets/revisions/62580d9e640e?raw)