---
title: "Get all scenes"
method: GET
path: "/api/v1/scenes"
tags: ["scenes"]
---

# Get all scenes

`GET /api/v1/scenes`

Retrieve a paginated list of scenes with their metadata and associated links.

    This endpoint allows you to:
    - Get all scenes in your workspace
    - Filter scenes by collection ID
    - Paginate through large sets of scenes
    - Access read-only and shared slides links for each scene

    <Callout type="info">
    Scenes are returned with their complete metadata including creation/modification dates, pinned status, and associated sharing links.
    </Callout>

    **Use cases:**
    - Building a scene browser or gallery
    - Syncing scenes with external systems
    - Creating scene management dashboards
    - Implementing search and filter functionality

## Query parameters

- `limit` integer
- `offset` integer
- `collectionId` string

## Response `200`

This response returns a paginated list of all scenes.

- object — This response returns a paginated list of all scenes.
  - `limit` number, required — The maximum number of items to return.
  - `offset` number, required — The number of items to skip before starting to collect the result set.
  - `hasNextPage` boolean, required — Indicates if there are more pages available.
  - `data` object[], required
    - `metadata` object, required
      - `workspace` string, required
      - `name` string, required
      - `isUntitled` boolean
      - `created` string, required
      - `updated` string, required
      - `previewUrl` string, required
      - `previewFilename` string, required
      - `previewBackground` string, required
      - `isDeleted` boolean, required
      - `isPrivate` boolean, required
      - `creator` string, required
      - `updater` string, required
      - `sceneVersion` string, required
      - `contentEpoch` integer, required
      - `lastAcknowledgedVersion` integer
      - `linkSharing` union, required
        - 0
        - 1
        - 3
      - `readComments` boolean
      - `writeComments` boolean
      - `allowCalls` boolean
      - `collection` string, required
      - `updateCount` number, required
      - `revisionCount` number, required
      - `lastRevision` string, required
      - `totalElements` number, required
      - `deletedElements` number, required
      - `pinned` boolean, required
      - `hasNonDeletedFrames` boolean
      - `isSlidesSharingEnabled` boolean
      - `isWelcomeScene` boolean
      - `id` string, required
    - `readOnlyLinks` object[], required
      - `id` string, required
      - `scene` string, required
      - `workspace` string, required
      - `created` string, required
      - `updated` string, required
      - `updatedBy` string, required
      - `creator` string, required
      - `preview` string, required
      - `previewPath` string, required
      - `type` 'readonly', required
      - `status` union, required
        - 'active'
        - 'inactive'
      - `name` string, required
      - `data` object, required
        - `showTitle` boolean
        - `showMenu` boolean
        - `darkMode` boolean
        - `disableInteraction` boolean
        - `showDarkModeToggle` boolean
        - `showFrameOutlines` boolean
        - `x` number, required
        - `y` number, required
        - `width` number, required
        - `height` number, required
    - `sharedSlidesLinks` object[], required
      - `id` string, required
      - `scene` string, required
      - `workspace` string, required
      - `created` string, required
      - `updated` string, required
      - `updatedBy` string, required
      - `creator` string, required
      - `preview` string, required
      - `previewPath` string, required
      - `isActive` boolean, required
      - `type` 'slides', required
      - `data` object, required
        - `name` string, required
        - `showSlideTitle` boolean, required
        - `animateSlides` boolean, required
        - `disallowDownload` boolean
        - `autoPlaySlides` number

## Other responses

- `400` — This response indicates that the request was malformed or contained invalid parameters.
- `401` — This response indicates that the client must authenticate to access the requested resource.
- `403` — This response indicates that the client does not have permission to access the requested resource.
- `404` — This response indicates that the requested resource could not be found.

---

[API](https://skmtc.net/excalidraw/apis/excalidraw-api.md) · [All operations](https://skmtc.net/excalidraw/apis/excalidraw-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/excalidraw/excalidraw-api/revisions/c1404d1545ba/schema)