Skip to content
mxHeadless
REST API gateway for headless frontends on MODX 3. Resources, objects, OpenAPI, API keys, and OAuth
  1. Extras
  2. mxHeadless
  3. API
  4. Preview

Preview

Query parameter ?preview=true on resource or page GET includes unpublished content.

Who can

IdentityCondition
AnonymousDenied
SessionMODX permission view_unpublished
API key / OAuthScope preview and the key user's ACL
bash
curl -s 'https://example.com/api/v1/resources/12?preview=true' \
  -H 'Authorization: Bearer mxh_...'

Context and field policy still apply. Hidden fields are not returned.

Cache

Preview responses use Cache-Control: private, no-store. Do not cache on a CDN. See HTTP caching.

See also