Skip to navigation
RESTRegions

Get Region

This feature is in beta and may change. Requests return 403 until the feature flag is enabled for your site or workspace.

Gets one region in one locale. The element tree is included only with include=elements.

Authentication

x-api-keystring

API key authentication with an App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ).

OR
x-api-keystring

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

Path parameters

idstringRequired

The region ID. URL-encode it if it contains reserved characters such as / or $.

Query parameters

siteIdstringRequiredformat: "uuid"
The site ID the region belongs to.
localestringOptional

The locale to get the region in. Accepts either a locale code (e.g. en-US) or a site_locale UUID. Defaults to the site’s default locale.

includeenumOptional

Include additional data in the response. Omit for the region records alone.

Supported values:

  • elements - include the region’s element tree.
Allowed values:

Response

objectenum
Allowed values:
idstring
The region ID. Assigned by the host, not generated by Makeswift.
namestring
The region name.
typestring
The component type at the root of the region's element tree.
localestring
The locale of this region.
updatedAtdatetime
The region last update date and time.
versioninteger>=0
The version of the region's element tree. It increases with every change to the tree. Pass it to Update Region to update the region only if it has not changed since.
elementsobject or null

The root of the region’s element tree. null unless include=elements.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error