Skip to main content
GET
Get a website

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Query Parameters

websiteId
string

Website id. Provide either this or the organizationSlug + websiteSlug pair.

Minimum string length: 1
organizationSlug
string

URL slug of the owning organization. Pair with websiteSlug to look the website up by slug instead of id.

websiteSlug
string

Website URL slug within the organization. Pair with organizationSlug.

Response

The requested website with the caller’s schema- and domain-management flags.

id
string
required

Unique website id.

organizationId
string
required

Id of the organization that owns the website.

name
string
required

Display name, 1–200 characters.

slug
string
required

URL-safe identifier unique among active websites in the organization.

customDomainsEnabled
boolean
required

Whether custom domains are enabled. Enabling is owner-only and makes the website a billable site; custom domains can only be attached while true.

headVersion
integer
required

Latest draft source version number; starts at 1.

publishedVersion
integer | null
required

Currently published version. null when the website is not published.

createdAt
string<date-time>
required

When the website was created.

updatedAt
string<date-time>
required

When the website was last modified.

canManageSchema
boolean
required

Whether the caller can create and modify the CMS schema.

canManageDomains
boolean
required

Whether the caller can create and manage domains.

faviconUrl
string | null
required

Public URL of the current favicon image. null when no available favicon is configured. Change it with the favicon endpoint.