Read a public document

GET

/api/v1/public/{slug}/edit

const url = 'https://example.com/api/v1/public/example/edit';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/public/example/edit

Requires a valid public link and guest editing session. It returns 403 when the link does not allow edits, 404 when the document is missing, or 429 when the request limit is reached. Route: /api/v1/public/{slug}/edit. Inputs: slug, X-Public-Password. Do not automatically replay this operation after an uncertain result.

Parameters

Path Parameters

slug

required

string

Header Parameters

X-Public-Password

string

Responses

403

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}