Schemas

getSchema

Changed on

Gets the latest version of the Schema. Pass ?id= to get a specific version by ID.

get/v1/entity/schemas/{slug}

Request

  • Base URL
    https://entity.sls.epilot.io
  • URL
    https://entity.sls.epilot.io/v1/entity/schemas/{slug}
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-id

Path parameters

slugstring required

URL-friendly identifier for the entity schema

Example:contact

Entity Type

Query parameters

idstring uuid

Generated uuid for schema

latestboolean

No longer has any effect: schema freezing is retired and the latest version is always returned.

Response

Success

idstring uuid

Generated uuid for schema

created_atstring
updated_atstring
commentstring
frozenboolean

No longer returned: schema freezing is retired.

latestboolean

No longer returned: every read returns the latest version.

_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
require_change_commentboolean

When true, the entity builder requires a change comment before saving a new version of this schema. Absent is treated as false. Enforced by the builder UI only; the API does not reject schema writes without a comment.

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

  • b7d4f45d1518Revision changes
    • info

      added to the ///// response property anyOf list for the response status

    • info

      added to the /////// response property anyOf list for the response status

  • 299db8038dd4Revision changes
    • info

      added the optional property //// to the response with the status