--- title: "listSchemas" method: GET path: "/v1/entity/schemas" tags: ["Schemas"] --- # listSchemas `GET /v1/entity/schemas` Get the latest versions of all schemas ## Query parameters - `unpublished` boolean - `latest` boolean - `exclude` string[] - `include` string[] ## Response `200` Success - object - `results` EntitySchemaItem[] - `id` string, uuid — Generated uuid for schema - `created_at` string - `updated_at` string - `comment` string - `source` object - `id` string - `type` string - `frozen` boolean — Indicates this schema is currently frozen. Present when the returned version is the frozen version. - `latest` boolean — Indicates this is the latest version of the schema. Both frozen and latest can be true if no changes were made since freezing. - `_summary` boolean — Indicates this is a truncated summary schema (attributes trimmed to summary_attributes only, no capabilities or group_settings) - `slug` string, required — URL-friendly identifier for the entity schema - `version` integer - `blueprint` string, uuid — Reference to blueprint - `feature_flag` string — This schema should only be active when the feature flag is enabled - `enable_setting` string[] — This schema should only be active when one of the organization settings is enabled - `name` string, required — User-friendly identifier for the entity schema - `plural` string, required - `description` string - `docs_url` string, uri - `category` string - `published` boolean - `draft` boolean - `icon` string - `title_template` string — Template for rendering the title field. Uses handlebars - `ui_config` object - `table_view` union - EntityDefaultTable - `view_type` 'default' - `row_actions` union[] - union - … - `bulk_actions` union[] - union - … - `navbar_actions` object[] - `type` string, required - `options` object[] - … - `enable_thumbnails` boolean — Enable the thumbnail column - RedirectEntityView - `view_type` 'redirect' - `route` string - EntityViewDisabled - `view_type` 'disabled' - `create_view` union - EntityDefaultCreate - `view_type` 'default' - `search_params` object - RedirectEntityView - `view_type` 'redirect' - `route` string - EntityViewDisabled - `view_type` 'disabled' - `edit_view` union - EntityDefaultEdit - `view_type` 'default' - `search_params` object - `summary_attributes` string[] — List of attribute names that we show in the summary header - RedirectEntityView - `view_type` 'redirect' - `route` string - EntityViewDisabled - `view_type` 'disabled' - `single_view` union - EntityDefaultEdit - `view_type` 'default' - `search_params` object - `summary_attributes` string[] — List of attribute names that we show in the summary header - RedirectEntityView - `view_type` 'redirect' - `route` string - EntityViewDisabled - `view_type` 'disabled' - `list_item` object - `summary_attributes` union[] - union - SummaryAttribute — Represents an expanded version of an attribute to be displayed in the list item summary. This configuration can be used in the following way: ```js { "label": "Price components" "value": "{{item.prices.length}} price components" "show_as_tag": true "render_condition": "is_composite_price = "true"" } ``` The value field supports handlebar expressions from which you can pick any field from the entity state. - … - string — List of attributes to show in list item - `quick_actions` EntityAction[] - `action` string, required — A unique action name - `label` string, required - `icon` string - `permission` string — Permission required to show the action. If not provided, the action will be shown to all users. - `ui_config` object - `content_direction` 'row' | 'column' — Show attributes in a row or column - `sharing` object - `show_sharing_button` boolean — Show the sharing button in entity detail view - `capabilities` EntityCapability[], required - `id` string — ID for the entity capability - `name` string, required — Unique name for the capability - `title` string — Human readable title of the capability - `attributes` Attribute[] — unresolved $ref - `_purpose` ClassificationId[] - `_manifest` string[], nullable — Manifest ID used to create/update the schema capabilility - `app_id` string — ID of the app if the capability is provided by an app - `ui_config` object - `is_filterable` boolean — Whether the capability is filterable - `ui_hooks` object[] - `hook` string, required — name of the hook to use - `render_condition` string - `order` integer — render order (ascending) - `title` string - `group_expanded` boolean — Sets the group expand/collapse default state - `import` string — package to be imported - `component` string — the component to be dynamically loaded - `route` string — route for specified capability - `icon` string — Preview icon name(As in Base elements) for the capability - `disabled` boolean — Whether capability should be disabled - `header` boolean — Specific to Activity pilot - `requiredPermission` object — Require a permission to display UI hook - `action` string, required - `resource` string - `feature_flag` string — This capability should only be active when the feature flag is enabled - `settings_flag` SettingFlag[] — This capability should only be active when all the settings have the correct value - `name` string — The name of the organization setting to check - `enabled` boolean — Whether the setting should be enabled or not - `schemas` object[] — Schema-specific configuration for the capability - `schema` string, required — Entity schema slug - `group_settings` EntitySchemaGroup[] — A list of Group Titles and associated settings if present. - `label` string, required - `id` string - `order` integer — Render order of the group - `expanded` boolean — Expanded by default - `render_condition` string — Only render group when render_condition resolves to true - `_purpose` ClassificationId[] — Only render group when one of the purposes is enabled - `_manifest` string[], nullable — Manifest ID used to create/update the schema group - `feature_flag` string — This group should only be active when the feature flag is enabled - `settings_flag` SettingFlag[] — This group should only be active when all the settings have the correct value - `name` string — The name of the organization setting to check - `enabled` boolean — Whether the setting should be enabled or not - `info_tooltip_title` object - `key` string — Translation key for info tooltip - `default` string — Default string for info tooltip - `layout_settings` object — Custom grid definitions for the layout. These settings are composed by managed and un-managed properties: - Managed Properties: are interpreted and transformed into layout styles - Un-managed Properties: are appended as styles into the attribute mounting node - `grid_gap` string — Defines the grid gap for the mounting node of the attribute. - `grid_template_columns` string — Defines the grid column template for the mounting node of the attribute. - `dialog_config` object - `attributes` Attribute[], required — An ordered list of attributes the entity contains — unresolved $ref - `_purpose` string[] - `_manifest` string[], nullable — Manifest ID used to create the schema - `explicit_search_mappings` SearchMappings — Advanced: explicit Elasticsearch index mapping definitions for entity data - `group_headlines` GroupHeadline[] - `id` string, uuid - `name` string, required - `label` string, required - `layout` string - `group` string, required — The group of headline attribute - `order` integer — The order of headline attribute - `type` 'headline', required - `enable_divider` boolean - `divider` 'top_divider' | 'bottom_divider' - `_purpose` ClassificationId[] - `_manifest` string[], nullable — Manifest ID used to create/update the schema group headline ## Changes - **2026-07-21** `623caa43b2a2` — 70 info - added the optional property `results/items/allOf[#/components/schemas/EntitySchema]/attributes/items/anyOf[#/components/schemas/AddressAttribute]/allOf[#/components/schemas/BaseAttribute]/data_classification` to the response with the `200` status - added the optional property `results/items/allOf[#/components/schemas/EntitySchema]/attributes/items/anyOf[#/components/schemas/AddressRelationAttribute]/allOf[#/components/schemas/BaseAttribute]/data_classification` to the response with the `200` status - added the optional property `results/items/allOf[#/components/schemas/EntitySchema]/attributes/items/anyOf[#/components/schemas/AutomationAttribute]/allOf[#/components/schemas/BaseAttribute]/data_classification` to the response with the `200` status - added the optional property `results/items/allOf[#/components/schemas/EntitySchema]/attributes/items/anyOf[#/components/schemas/BooleanAttribute]/allOf[#/components/schemas/BaseAttribute]/data_classification` to the response with the `200` status - …66 more [Change history](https://skmtc.dev/epilot/apis/entity-api/changes/v1/entity/schemas/get.md) --- [API](https://skmtc.dev/epilot/apis/entity-api.md) · [All operations](https://skmtc.dev/epilot/apis/entity-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/epilot/entity-api/revisions/623caa43b2a2/schema)