---
title: "GET /v1/entities/{entityId}"
method: GET
path: "/v1/entities/{entityId}"
tags: ["entities"]
---

# GET /v1/entities/{entityId}

`GET /v1/entities/{entityId}`

## Request

- Base URL: `https://help.steep.app` (the document declares no server; this is the origin it was published from)
- URL: `https://help.steep.app/v1/entities/{entityId}`
- Auth: none declared

Get a single entity by `id`, with its properties, primary key column and linked metrics. Use after list entities to inspect what an entity holds.

## Path parameters

- `entityId` string, required: `entity.id` — Unique resource ID (opaque).

## Response `200`

Response for status 200

- object
  - `id` string, required: Unique resource ID (opaque).
  - `identifier` string, required: Readable semantic model key. Used to cross-reference objects in the semantic model.
  - `name` string, required: Display name. Not unique — `identifier` is the stable key.
  - `createdAt` string, required
  - `updatedAt` string, required
  - `synonyms` string[], required: Other names people use for this, e.g. abbreviations or terms in other languages.
  - `agentInstructions` unknown, required
  - `module` string, required: `identifier` of the module this entity belongs to. Readable semantic model key. Used to cross-reference objects in the semantic model.
  - `primaryKeyColumn` string, required: Warehouse column that uniquely identifies a row.
  - `properties` object[], required: Attributes of this entity, in display order.
    - `name` string, required
    - `type` 'number' | 'time' | 'date' | 'string' | 'boolean' | 'uuid' | 'geography', required
    - `column` string, required: Warehouse column backing this property.
  - `metricIdentifiers` string[], required: `identifier`s of the metrics linked to this entity. Match `identifier` from list metrics, search metrics, or get metric by `id`.
  - `externalSource` 'dbt-cloud' | 'cube' | 'code', required: System that manages this definition. `null` when managed in Steep.

## Other responses

- `401`: Response for status 401
- `403`: Response for status 403
- `422`: Response for status 422
- `429`: Response for status 429
- `500`: Response for status 500

---

[API](https://skmtc.dev/steep/apis/steep-api.md) - [All operations](https://skmtc.dev/steep/apis/steep-api/llms.txt) - [OpenAPI document](https://skmtc.dev/steep/apis/steep-api/revisions/cc9677742952?raw)