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}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects/{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

The ID of the required settings object.

path required


Response codes

Code Description



No object available for the given objectId

Response body

The SettingsObjectResponse object

The response to a creation- or update-request.

Element Type Description
invalidValue SettingsValue
objectId string

For a successful request, the ID of the created or modified settings object.

code integer

The HTTP status code for the object.

error Error

The Error object

Element Type Description
constraintViolations ConstraintViolation[]

A list of constraint violations

message string

The error message

code integer

The HTTP status code

The ConstraintViolation object

A list of constraint violations

Element Type Description
parameterLocation string
location string
message string
path string

The SettingsObject object

A settings object.

Element Type Description
schemaVersion string

The version of the schema on which the object is based.

updateToken string

The update token of the object. You can use it to detect simultaneous modifications by different users.

It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.

If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.

author string

The user (identified by a user ID or a public token ID) who performed that most recent modification.

modified integer

The timestamp of the last modification.

objectId string

The ID of the settings object.

created integer

The timestamp of the creation.

scope string

The scope that the object targets.

schemaId string

The schema on which the object is based.

value SettingsValue
summary string

A short summary of settings.

The SettingsValue object

The value of the setting.

It defines the actual values of settings' parameters.

The actual content depends on the object's schema.

Element Type Description