---
title: "Share State"
method: GET
path: "/api/py/portals/shares"
tags: ["portals"]
---

# Share State

`GET /api/py/portals/shares`

## Request

- Base URL: `https://api.getauctor.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getauctor.com/api/py/portals/shares`
- Auth: none declared

## Query parameters

- `artifact_type` 'file' | 'session' | 'plan_item', required
- `artifact_id` string[], required
- `include_sources` boolean

## Response `200`

Successful Response

- PortalShareState[]
  - `artifact_type` 'file' | 'session' | 'plan_item', required
  - `artifact_id` string, uuid, required
  - `account_id` string, uuid, required
  - `account_name` string, required
  - `account_image_url` string, nullable, required
  - `project_linked` boolean, required
  - `portals` PortalShareStatePortal[], required
    - `id` string, uuid, required
    - `title` string, required
    - `space_id` string, uuid, required
    - `portal_artifact_id` string, uuid, nullable, required
    - `is_copy` boolean, required
    - `has_unpublished_changes` boolean, required
    - `portal_version_number` integer, nullable, required
    - `request_status` 'review_pending' | 'approval_pending' | 'approved' | 'changes_requested' | 'reviewed', nullable, required
    - `last_status_change` PortalStatusChange, required
      - `actor_name` string, nullable, required
      - `actor_image_url` string, nullable, required
      - `new_request_status` 'review_pending' | 'approval_pending' | 'approved' | 'changes_requested' | 'reviewed', nullable, required
      - `occurred_at` string, date-time, required
    - `is_landing_page` boolean, required
    - `can_manage` boolean, required
  - `sources` PortalCitedSource[], required
    - `type` 'file' | 'session', required
    - `id` string, uuid, required
    - `title` string, required
    - `subtitle` string, nullable, required
    - `reference_count` integer, required
    - `shared_portal_ids` string[], required
    - `in_document_project` boolean, required
    - `file_type` string, nullable, required
    - `is_template` boolean, required
    - `source_category` string, nullable, required
    - `source_format` string, nullable, required
    - `meeting_platform` string, nullable, required
    - `session_type` string, nullable, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `413`: Request Entity Too Large
- `422`: Validation Error
- `500`: Internal Server Error

## Changes

- **2026-10-27** `3245ffb53690`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getauctor/apis/getauctor-api/changes/api/py/portals/shares/get.md)

---

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