Skip to main content
GET
Get Entity Relationships
Returns direct canonical relationships for one Shoal entity id.

Path Parameters

  • id (integer, required)

Query Parameters

  • limit (integer, optional, default 50, max 50)
  • offset (integer, optional, default 0, max 250)

Request

cURL

Response (200)

Notes

  • Relationship traversal is direct and canonical. It is not a full multi-hop graph query.
  • direction is relative to the requested entity id.
  • searchExpand indicates whether the relationship is currently used in Shoal expansion logic.

Errors

  • 400 if id is missing
  • 404 if the entity does not exist
  • 500 on internal server error