EXexcalidraw
collections
scenes

Get scenes in collection

Changed on

Retrieve all scenes that belong to a specific collection.

This endpoint allows you to:
- List all scenes within a collection
- Paginate through scenes for large collections
- Access scene metadata and sharing links

**Use cases:**
- Displaying collection contents in UI
- Filtering scenes by collection
- Building collection detail pages
get/api/v1/collections/{collectionId}/scenes

Request

  • Base URL
    https://api.excalidraw.com
  • URL
    https://api.excalidraw.com/api/v1/collections/{collectionId}/scenes
  • Auth
    HTTP bearer

Path parameters

collectionIdstring required

Collection ID. Personal API keys may use 'private' for the key owner's virtual private collection. Workspace API keys cannot access private collections.

Query parameters

limitinteger

The number of items to return per page.

offsetinteger

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

Response

This response returns a paginated list of scenes within the specified collection.

limitnumber required

The maximum number of items to return.

offsetnumber required

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

hasNextPageboolean required

Indicates if there are more pages available.

Changes

  • 9eecb866ae18Revision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

  • ca05c1ff5a67Revision changes
    • warning

      removed the optional property /// from the response with the status