Get the space's settings
const url = 'https://example.com/v1/example/data/settings';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/example/data/settings \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The project ID of the space
Responses
Section titled “Responses”The space’s settings
Settings for how the space behaves for visitors and editors.
object
Not used. Whether a space is public is set separately from its document.
Whether people nearby can find the space from their location. Only public spaces with a georeference are found.
The language editors write in by default, as a BCP 47 tag, e.g. en or en-GB. It isn’t used to choose which translation visitors see.
How distances are shown to visitors who haven’t chosen for themselves. Defaults to metres.
Landmark fields that editors must fill in before saving a landmark, as field name → true. Only enforced in the editor. The fields that can be required are subtitle, description, pose, tags, banner and content.
object
Whether to stop the space’s walls and floors hiding routes and markers that are behind them in AR.
Whether routes can go through places with only 0.5m of headroom, rather than the usual 1.5m. The navigation mesh must be regenerated after it’s changed.
Whether choosing a landmark that has nothing more than a title and subtitle starts navigating straight away, rather than first showing its page.
The image behind the screens visitors see when they first open the space. Defaults to default.
The path of the image to use when onboardingImageType is custom, a key into the space’s file store - not a URL.
Whether editors get extra tools for placing and moving landmarks precisely. Only affects the editor.
A phone number visitors can call for help, offered while they’re navigating. Best given in international format.
Whether searching for landmarks only finds titles that contain exactly what was typed. Otherwise search also allows near matches, and looks at subtitles and categories too.
How far, in metres, routes keep from walls and obstacles, so gaps narrower than twice this aren’t walkable. Defaults to 0.2. The navigation mesh must be regenerated after it’s changed.
Whether every attempt to work out where a visitor is uses several camera images, rather than one. Can be more accurate, but takes longer.
Whether visitors can scan the Accessible QR codes placed in the space for more information.
Example
{ "defaultDistanceUnit": "meters", "mandatoryLandmarkFields": { "banner": true, "tags": true }, "onboardingImageType": "default", "assistanceTelephone": "+44 20 7946 0000"}The token is missing or invalid.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}The token has no access to this space.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}Too many requests. Retry after Retry-After seconds.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}Headers
Section titled “Headers”Seconds to wait before retrying
Something upstream failed.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}The space is moving between servers. Retry after Retry-After seconds.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}Headers
Section titled “Headers”Seconds to wait before retrying
Something upstream timed out.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}