STsteep
entities

GET /v1/entities/{entityId}

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.

Request

  • Base URL
    https://help.steep.app (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

entityIdstring required

entity.id — Unique resource ID (opaque).

Response

Response for status 200

idstring required

Unique resource ID (opaque).

identifierstring required

Readable semantic model key. Used to cross-reference objects in the semantic model.

namestring required

Display name. Not unique — identifier is the stable key.

createdAtstring required
updatedAtstring required
synonymsstring[] required

Other names people use for this, e.g. abbreviations or terms in other languages.

agentInstructionsunknown required
modulestring required

identifier of the module this entity belongs to. Readable semantic model key. Used to cross-reference objects in the semantic model.

primaryKeyColumnstring required

Warehouse column that uniquely identifies a row.

metricIdentifiersstring[] required

identifiers 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.

Changes

No recorded changes to this operation across all 1 revision of this API.