For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign in
DocsAPI ReferenceChangelog
DocsAPI ReferenceChangelog
    • Overview
    • Authentication
  • REST
      • POSTCreate Site
      • GETList Sites
      • GETGet Site
      • PATCHUpdate Site
      • DELDelete Site
      • POSTDuplicate Site
Sign in
LogoLogo
RESTSites

Get Site

GET
https://api.makeswift.com/v2/sites/:siteId
GET
/v2/sites/:siteId
$curl https://api.makeswift.com/v2/sites/siteId \
>     -H "x-api-key: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "object": "site",
3  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4  "name": "Hearth Furniture Company",
5  "hostOrigin": "https://hearthfurniture.com",
6  "publicApiKey": "550e8400-e29b-41d4-a716-446655440000",
7  "defaultLocale": "en-US",
8  "localeManagementMode": "internal",
9  "defaultLocalePathPrefix": "/en"
10}
Returns a site by its ID.
Was this page helpful?
Previous

List Sites

Next

Update Site

Built with

Authentication

x-api-keystring

API key authentication. Accepts either:

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

Path parameters

siteIdstringRequiredformat: "uuid"
The site ID for the site you are requesting.

Response

objectenum
The type of the object
Allowed values:
idstringformat: "uuid"
namestring
The site name.
hostOriginstring or nullformat: "uri"
The public URL where your site is hosted. This is the URL that Makeswift uses to render your site for editing.
publicApiKeystringformat: "uuid"
The publishable API key that a host can use to get page and component data for rendering your site.
defaultLocalestring
The primary locale of this site.
localeManagementModeenum
Controls whether locales are managed internally via the builder or externally via API.
Allowed values:
defaultLocalePathPrefixstring or null

Errors

403
Forbidden Error