Websites

Get a website

Returns a single website by websiteId, or by its organizationSlug + websiteSlug pair when starting from a URL — provide exactly one of the two identifications. The response includes whether the caller can manage the website’s CMS schema and domains. Websites in the trash remain retrievable by id (see websites.list with status=deleted for their purge timing); slug lookups only resolve active websites, and inaccessible or deleted resources return 404.

get/websites/find

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/websites/find
  • Auth: HTTP bearer

Query parameters

websiteIdstring

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

organizationSlugstring

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

websiteSlugstring

Website URL slug within the organization. Pair with organizationSlug.

Response

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

idstring required

Unique website id.

organizationIdstring required

Id of the organization that owns the website.

namestring required

Display name, 1–200 characters.

slugstring required

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

customDomainsEnabledboolean 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.

headVersioninteger required

Latest draft source version number; starts at 1.

publishedVersioninteger nullable required

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

createdAtstring date-time required

When the website was created.

updatedAtstring date-time required

When the website was last modified.

canManageSchemaboolean required

Whether the caller can create and modify the CMS schema.

canManageDomainsboolean required

Whether the caller can create and manage domains.

faviconUrlstring nullable required

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

Changes

No recorded changes to this operation across all 1 revision of this API.