RESTRegions

List Regions

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

Lists a site’s regions for one locale. Element trees are included only with include=elements.

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)

Query parameters

siteIdstringRequiredformat: "uuid"
The site ID to list regions from.
limitintegerOptional1-100Defaults to 20
The maximum number of regions to return.
startingAfterstringOptional
The pagination cursor. This is used to indicate what ID to list from.
localestringOptional

The locale to list regions for. 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 each region's element tree.
Allowed values:

Response

objectenum
Allowed values:
datalist of objects
The regions on the site in the requested locale.
hasMoreboolean
The flag that indicates whether there are more regions available.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error