Settings API - GET an object

Gets the specified settings object.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}
  • SaaS https://{your-environment-id}{objectId}


To execute this request, you need the Read settings ( permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
objectId string

ID of a settings object (e.g. Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=)

path required


Response codes

Code Description



No object available for the given objectId

Response body

The SettingsObjectErrorResponse object

The response to a failed settings object request

Element Type Description
invalidValue SettingsValue
error Error
code integer

The HTTP Status code

The Error object

Element Type Description
constraintViolations ConstraintViolation[]
message string
code integer

The ConstraintViolation object

Element Type Description
parameterLocation string
location string
message string
path string

The PersistedObject object

A persisted settings object

Element Type Description
modified integer

Timestamp of last modification

updateToken string

Generated upon retrieval and can be used to detect concurrent modification when set during write operations

schemaVersion string

The schema version which was used to create this object

author string

User id or public token id of last modifier

scope string

The scope this value is defined and persisted at

schemaId string

The schema for which the values are valid

value SettingsValue
objectId string

The unique identifier of this settings object

summary string

The Human-readable summary of setting contents

created integer

Timestamp of creation

The SettingsValue object

A single value to be written to the settings. Its content depends on the schema defined for this type of setting.

Element Type Description