Sign in

v1

latestOpenAPI 3.1.02026-08-04177151.5 KB
site

Get Site

Returns a site by its ID.

get/v2/sites/{siteId}

Path parameters

siteIdstring uuid required

The site ID for the site you are requesting.

Headers

x-api-keystring required

API key authentication. Accepts either:

  • App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)
  • Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Response

object'site' required

The type of the object

idstring uuid required
namestring required

The site name.

hostOriginstring uri nullable required

The public URL where your site is hosted. This is the URL that Makeswift uses to render your site for editing.

publicApiKeystring uuid required

The publishable API key that a host can use to get page and component data for rendering your site.

defaultLocalestring required

The primary locale of this site.

defaultLocalePathPrefixstring nullable
localeManagementMode'internal' | 'external' required

Controls whether locales are managed internally via the builder or externally via API.