/api/public

GET /api/public/document/{uuid}

Changed on

Fetch a publicly-accessible Document. Does not require auth credentials. Public sharing must be enabled.

Returns a Document with sensitive fields removed (excludes collection_id, permissions, creator details, etc.). Includes all embedded Cards with their metadata hydrated so the frontend doesn't need to make separate requests for each card — just like public Dashboards do.

get/api/public/document/{uuid}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

uuidstring required

value must be a valid UUID.

Response

Successful response

Changes