Skip to main content
GET
Get the website

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Query Parameters

siteId
integer

Which website, when the organization has more than one. Defaults to its default website.

Response

The website, its pages and its layout

A website belonging to the organization. Every field here describes the draft, except url, published, activeReleaseVersion and lastPublishedAt, which describe what the public is currently being served.

id
integer
name
string
slug
string

Platform host label - the site answers on <slug>.1club.me.

domain
string | null

Custom domain, when one is pointed at this site.

isDefault
boolean

True for the site an organization-wide caller means by "the website". Exactly one per organization.

isActive
boolean

False means the site is switched off and serves nothing publicly, whatever the draft contains.

url
string

Public URL - the custom domain when set, else the platform host.

previewUrl
string

The same site rendered from the unpublished draft - the link to review edits before publishing. Carries a signed grant that expires 24 hours after this response was generated; read the website again for a fresh one. Anyone holding the link can view the draft, so it is shareable without a login but should be treated as sensitive.

published
boolean

Whether the site has ever been published. False means nothing is publicly reachable yet.

activeReleaseVersion
integer | null
lastPublishedAt
string<date-time> | null
themeSupport
enum<string> | null
Available options:
both,
light,
dark
defaultTheme
enum<string> | null
Available options:
light,
dark,
system
supportedLocales
string[] | null

Locales the site serves, which is what its hreflang alternates and sitemap.xml advertise. Organization-level - see PATCH /v1/platform/website.

defaultLocale
string | null

Locale served at the site root. Organization-level.

seoSettings
object

Site-wide SEO defaults. Each field is a fallback a page can override.

pages
object[]

Present when fetching one website; omitted from the site list.

layout
object

Header and footer, rendered on every page.

hasCustomCss
boolean
updatedAt
string<date-time>