Skip to main content

List a record's relationships

GET 
/api/v1/entities/:entityId/relationships

Returns the relationships attached to one record, in either direction. Each carries the counterpart record and whether the link is active, expired or future-dated, so a closed employment does not read as a current one. Filter by state, or ask for the relationships that were in force on a given date. Requires entity.relationship.read.

Request​

Responses​