---
title: "List metadata model entities"
method: GET
path: "/catalog/v1/metadata-model/entities"
tags: ["Metadata Model Entities"]
---

# List metadata model entities

`GET /catalog/v1/metadata-model/entities`

## Request

- Base URL: `https://your-environment.ataccama.one/api`
- URL: `https://your-environment.ataccama.one/api/catalog/v1/metadata-model/entities`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/docs/catalog/v1/metadata-model/entities/get.ts> (a function with typed inputs; its response is checked against the schema)

List the entity definitions in the metadata model.

Paging is forward-only.

## Query parameters

- `after` string
- `size` integer
- `search` string
- `name` string

## Response `200`

Paginated list of metadata model entities.

- object
  - `meta` PaginationMetadata, required
    - `next` string: Encoded string representing the next page. Omitted if there are no more pages.
    - `total` integer: Total number of items available across all pages.
  - `data` MetadataModelEntity[], required
    - `name` string, required: The unique entity-type identifier, for example, `businessTerm`. Use it as the path parameter when retrieving a single entity definition.
    - `description` string: A human-readable description of the entity type.
    - `nodePaths` string[], required: The node paths under which entities of this type are located in the metadata model.
    - `superEntities` string[], required: The names of the entity types this type extends, ordered from the direct parent up to the root type. The chain is complete.
    - `subEntities` string[], required: The names of the entity types that directly extend this type.
    - `properties` MetadataModelEntityProperty[], required: The properties defined on the entity type.
      - `name` string, required: The property name as referenced by entity instances.
      - `description` string: A human-readable description of the property.
      - `type` string, required: @ExtensibleEnum The kind of the property: one of `SCALAR`, `SINGLE_EMBEDDED`, `ARRAY_EMBEDDED`, `SINGLE_REFERENCE`, or `ARRAY_REFERENCE`. Depending on `type`, each property carries one additional field: scalars carry a `scalarType`, and the embedded and reference variants carry an `entityName`.
      - `editable` boolean, required: Whether the property is writable. If `false`, the property is read-only, typically because its value is computed, for example, delegated to another property.
    - `editable` boolean, required: Whether entities of this type can be created, updated, or deleted. If `false`, entities of this type are read-only because they are managed by Ataccama.

## Other responses

- `400`: Bad request. The request parameters or body are invalid.
- `403`: Forbidden. You do not have permission to access the requested resource.

---

[API](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api.md) - [All operations](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/revisions/46f16e0487f8?raw)