Skip to documentation
Browse documentation
API reference / Entity graph
GET/v1/entities/{entityId}/relationshipsgraph:read

Traverse entity relationships

Operation ID: listEntityRelationships

Parameters

NameLocationTypeDescription
entityId

Required

pathstring uuid
cursorquerystringOpaque cursor returned by links.next.
limitqueryintegerPage size.

Example request

curl --request GET \
  --url 'https://api.data.hyran.co/v1/entities/0d1ddf83-2ef8-4b83-81bb-b193dc9ccffa/relationships?limit=100' \
  --header "Authorization: Bearer $HYRAN_DATA_API_TOKEN" \
  --header "Accept: application/json"

Responses

HTTP 200

Successful response

HTTP 400

Problem response

HTTP 401

Problem response

HTTP 403

Problem response

HTTP 404

Problem response

HTTP 409

Problem response

HTTP 429

Problem response

HTTP 500

Problem response

HTTP 503

Problem response

Try this operation

The credential is held only in React memory for this browser tab. Hyran Docs does not persist, proxy, inspect, or log it.