Read the shipped entity graph

The entity graph provides stable Hyran Data identities around source-system references. V1 contains styles, SKUs, materials, suppliers, BOM relationships, and immutable BOM publications.

Entity types

Start with GET /v1/entity-types. The result is the current allowlisted vocabulary. Do not assume a new type exists until this endpoint and the OpenAPI contract publish it.

Type	Meaning
`style`	A commercial style that groups sellable SKUs
`sku`	A specific sellable product variant
`material`	A normalized material referenced by a BOM
`supplier`	A normalized supplying organization
`bom_publication`	An immutable completed BOM replacement publication

Search entities

Use GET /v1/entities with an allowlisted type and optional label query q. Results use opaque cursor pagination. Exact external identifiers remain in each entity's external references rather than replacing the canonical Data entity ID.

curl --get https://api.data.hyran.co/v1/entities \
  --header "Authorization: Bearer $HYRAN_DATA_API_TOKEN" \
  --data-urlencode "type=sku" \
  --data-urlencode "q=NB-100" \
  --data-urlencode "limit=100"

Traverse relationships

Call GET /v1/entities/{entityId}/relationships with the canonical entity UUID. Traversal is bounded and paginated. The API does not accept unrestricted joins, caller-provided graph expressions, or SQL.