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

refstring required

Any registry ref. Slashes in refs must be URL-encoded (%2F).

Response

The node and its graph neighbourhood

refstring required

The entity ref ({domain}:{key}), the permanent identifier for this entity. Example: "make:tesla"

domainstring required

Entity domain, e.g. "make", "model", "model-year", "fuel-type"

namestring required

Display name, e.g. "Tesla"

parentRefstring nullable

Ref of the parent entity, for domains that nest (the parent of "model:mini/hardtop" is "make:mini")

childrenTruncatedboolean
countsobject

Related-resource counts, e.g. {"children": 42, "listings": 917, "recalls": 12}

linksobject

Related resources, keyed by relation name, each a server-relative path. Example: {"recalls": "/v2/recalls/entity/model-year:toyota/rav4/2021"}

Changes

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