Whiteboarding made easy

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

Scenes are returned with their complete metadata including creation/modification dates, pinned status, and associated sharing links.

Use cases:

Building a scene browser or gallery
Syncing scenes with external systems
Creating scene management dashboards
Implementing search and filter functionality

Authorization

apiKey

AuthorizationBearer <token>

The API will use the Authorization: Bearer <your-key> header for requests.

In: header

Query Parameters

limit?integer

The number of items to return per page.

Range1 <= value <= 100

offset?integer

The number of items to skip before starting to collect the result set.

Range0 <= value <= 9007199254740991

collectionId?string

Response Body

`application/json`

curl -X GET "https://api.excalidraw.com/api/v1/scenes"

{
  "limit": 0,
  "offset": 0,
  "hasNextPage": true,
  "data": [
    {
      "metadata": {
        "workspace": "string",
        "name": "string",
        "created": "string",
        "updated": "string",
        "previewUrl": "string",
        "previewFilename": "string",
        "previewBackground": "string",
        "isDeleted": true,
        "creator": "string",
        "updater": "string",
        "sceneVersion": "string",
        "lastAcknowledgedVersion": -9007199254740991,
        "linkSharing": 0,
        "collection": "string",
        "updateCount": 0,
        "revisionCount": 0,
        "lastRevision": "string",
        "totalElements": 0,
        "deletedElements": 0,
        "pinned": true,
        "hasNonDeletedFrames": true,
        "isWelcomeScene": true,
        "id": "string"
      },
      "readOnlyLinks": [
        {
          "id": "string",
          "scene": "string",
          "workspace": "string",
          "created": "string",
          "updated": "string",
          "updatedBy": "string",
          "creator": "string",
          "preview": "string",
          "previewPath": "string",
          "type": "readonly",
          "status": "active",
          "name": "string",
          "data": {
            "showTitle": true,
            "showMenu": true,
            "darkMode": true,
            "disableInteraction": true,
            "showDarkModeToggle": true,
            "showFrameOutlines": true,
            "x": 0,
            "y": 0,
            "width": 0,
            "height": 0
          }
        }
      ],
      "sharedSlidesLinks": [
        {
          "id": "string",
          "scene": "string",
          "workspace": "string",
          "created": "string",
          "updated": "string",
          "updatedBy": "string",
          "creator": "string",
          "preview": "string",
          "previewPath": "string",
          "isActive": true,
          "type": "slides",
          "data": {
            "name": "string",
            "showSlideTitle": true,
            "animateSlides": true,
            "disallowDownload": true,
            "autoPlaySlides": 100
          }
        }
      ]
    }
  ]
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "string"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "string"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "string"
}

Get all scenes

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`