Skip to main content
GET
Public Site by slug

Path Parameters

slug
string
required

The site's slug.

Query Parameters

lang
string

Response locale. ISO code (e.g. fr, de). When omitted, responds in the company's default locale. On reads an unsupported or unknown locale is ignored — the response comes back in the default locale, never a 422. Any translated field with no value in the requested locale falls back to its en value.

Example:

"fr"

Response

The Site.

Shared success envelope for list / show / create / update responses: the resource payload is returned alongside a top-level integer status and meta. Composed onto each resource response via allOf.

status
integer
required
Example:

200

meta
object
required

Response metadata included on every successful response body. request_id and timestamp are always present; list endpoints also add pagination.

site
object
required

Public Site read shape — the storefront (unauthenticated) projection. Closed so an authenticated-only field leaking onto the public surface is caught in conformance.