Docs

Get Public Document

GET /documents/public/{token}

GET/documents/public/{token}

Required Tokens

No authentication required. This is a public endpoint — anyone with the link token can call it.

Returns the document accessible via a public link token. Includes the document's name, description, TipTap content, variable definitions, and the link's pre-set variable values and allowed value constraints.

Inactive or expired links return 404 without indicating whether the link exists.

Path Parameters

FieldTypeRequiredDescription
tokenstringOptionalThe URL-safe token from the public link.

Response

{
  "id": "...",
  "name": "Production Day Sheet",
  "description": null,
  "content": "{...tiptap json...}",
  "variables": [
    {
      "id": "...",
      "name": "Area",
      "variableType": "Area",
      "isMultiSelect": false,
      "isRequired": true,
      "defaultValues": null
    }
  ],
  "variableValues": "{\"<variableId>\": \"<value>\"}",
  "allowedValues": null
}