---
title: "Dereference a ref: node + parents/children + counts + links"
method: GET
path: "/v2/entities/{ref}"
tags: ["entities"]
---

# Dereference a ref: node + parents/children + counts + links

`GET /v2/entities/{ref}`

## Request

- Base URL: `https://api.cardog.app`
- URL: `https://api.cardog.app/v2/entities/{ref}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Path parameters

- `ref` string, required

## Response `200`

The node and its graph neighbourhood

- EntityDetail
  - `ref` string, required: The entity ref ({domain}:{key}), the permanent identifier for this entity. Example: "make:tesla"
  - `domain` string, required: Entity domain, e.g. "make", "model", "model-year", "fuel-type"
  - `name` string, required: Display name, e.g. "Tesla"
  - `parentRef` string, nullable: Ref of the parent entity, for domains that nest (the parent of "model:mini/hardtop" is "make:mini")
  - `parents` object[]: Ancestors, nearest first: a model year lists its model, then its make
    - `ref` string, required: The entity ref ({domain}:{key}), the permanent identifier for this entity. Example: "make:tesla"
    - `domain` string, required: Entity domain, e.g. "make", "model", "model-year", "fuel-type"
    - `name` string, required: Display name, e.g. "Tesla"
    - `parentRef` string, nullable: Ref of the parent entity, for domains that nest (the parent of "model:mini/hardtop" is "make:mini")
  - `children` object[]: Direct children, capped. `childrenTruncated` is true when the list was cut.
    - `ref` string, required: The entity ref ({domain}:{key}), the permanent identifier for this entity. Example: "make:tesla"
    - `domain` string, required: Entity domain, e.g. "make", "model", "model-year", "fuel-type"
    - `name` string, required: Display name, e.g. "Tesla"
    - `parentRef` string, nullable: Ref of the parent entity, for domains that nest (the parent of "model:mini/hardtop" is "make:mini")
  - `childrenTruncated` boolean
  - `counts` object: Related-resource counts, e.g. {"children": 42, "listings": 917, "recalls": 12}
  - `links` object: Related resources, keyed by relation name, each a server-relative path. Example: {"recalls": "/v2/recalls/entity/model-year:toyota/rav4/2021"}

## Other responses

- `400`: Invalid request — grammar failure or unknown-but-well-formed refs, NAMED in `refs`/`details`, with nearest-ref `suggestions` where computable. Never a fuzzy fallback.
- `401`: No valid credential (API key, session, or internal token)
- `404`: Resource not found
- `429`: Per-minute rate limit exceeded
- `500`: Internal error

---

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