Docs
Landing pages

A preview link

GEThttps://api.norreach.app/v1/pages/{id}/preview-link

A 15-minute link that shows the working copy (or version) on the page's own address, for a look before anything is published. Needs pages:write, like the editor's preview.

pages:writeRole must allow: pages.editOperation id: get_page_preview_link
GET/pages/{id}/preview-link
curl -X GET "https://api.norreach.app/v1/pages/{id}/preview-link" \
  -H "Authorization: Bearer $NORREACH_API_KEY"
A preview link
{
  "object": "preview_link",
  "page_id": "5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d",
  "url": "https://acme.norreach.page/__preview/…",
  "expires_in": 900
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope pages:write. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Query parameters

version"draft" | string (uuid)query

Response

200application/json— A preview link

object"preview_link"required
page_idstring (uuid)required

An id (UUID).

urlstringrequired
expires_inintegerrequired

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
403role_forbiddenThe key's creator's role can't do this.
404not_foundThat doesn't exist.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.