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}


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 SchemaDefinitionSummariesList object

The list of available schema definitions

Element Type Description
totalCount integer

The total count of schemas in this list

items SchemaDefinitionSummary[]

The list of schemas

The SchemaDefinitionSummary object

A schema definition summary

Element Type Description
latestSchemaVersion string

The latest version of the schema

schemaId string

The identifier of the schema

displayName string

The display name of the schema