Sign in
Schemas

getSchema

By default gets the current version of the Schema (frozen version if frozen, otherwise latest). Pass ?latest=true to get the latest version when the schema is frozen. Pass ?id= to get a specific version by ID.

get/v1/entity/schemas/{slug}

Path parameters

slugstring required

URL-friendly identifier for the entity schema

Example:contact

Entity Type

Query parameters

idstring uuid

Generated uuid for schema

latestboolean

When true, return the latest version instead of the frozen version for frozen schemas.

Response

Success

idstring uuid

Generated uuid for schema

created_atstring
updated_atstring
commentstring
frozenboolean

Indicates this schema is currently frozen. Present when the returned version is the frozen version.

latestboolean

Indicates this is the latest version of the schema. Both frozen and latest can be true if no changes were made since freezing.

_summaryboolean

Indicates this is a truncated summary schema (attributes trimmed to summary_attributes only, no capabilities or group_settings)

slugstring required

URL-friendly identifier for the entity schema

versioninteger
blueprintstring uuid

Reference to blueprint

feature_flagstring

This schema should only be active when the feature flag is enabled

enable_settingstring[]

This schema should only be active when one of the organization settings is enabled

namestring required

User-friendly identifier for the entity schema

pluralstring required
descriptionstring
docs_urlstring uri
categorystring
publishedboolean
draftboolean
iconstring
title_templatestring

Template for rendering the title field. Uses handlebars

dialog_configobject
attributesAttribute[] required— unresolved $ref

An ordered list of attributes the entity contains

_purposestring[]
_manifeststring[] nullable

Manifest ID used to create the schema

explicit_search_mappingsSearchMappings

Advanced: explicit Elasticsearch index mapping definitions for entity data

Changes