Get a single document by ID (storefront callers see active documents only)

GET

/rest/v1/cms/document/{id}

Storefront callers — guest (no token) and customer — can only retrieve an active document: requesting an inactive one (documents.active = 0) by ID returns 404 rather than the row, and with it the /files/documents/ URL of the attached PDF that ?with=translations would otherwise expose. Backend callers are unaffected.

Parameters

Path Parameters

id*

ID of the document to retrieve

Type

integer

Required

Format

"int64"

Query Parameters

with

With relations

Type

string

Responses

Successful operation

Content-Type

application/json

"string"

GET

/rest/v1/cms/document/{id}

Playground

Variables

Key

Value

id*

with

Samples

Powered by VitePress OpenAPI