Settings API - GET all schemas

Lists all settings schemas available in your environment.

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


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.



The request doesn't provide any configurable parameters.


Response codes

Code Description


Response body

The SchemaList object

The list of available settings schemas.

Element Type Description
items SchemaStub[]

A list of settings schemas.

totalCount integer

The number of schemas in the list.

The SchemaStub object

The short representation of the settings schema.

Element Type Description
latestSchemaVersion string

The most recent version of the schema.

schemaId string

The ID of the schema.

displayName string

The name of the schema.