Relationships

Links between records — employment, ownership, care — including when each was in force.

📄️List relationships

Returns relationships across the tenant, filterable by type, either endpoint, or whether the link is currently in force. Requires `entity.relationship.read`.

📄️Get a relationship

Returns one relationship with its endpoints and its period. Requires `entity.relationship.read`.

📄️Update a relationship

Changes a relationship's details or its period — this is how you close a link that has ended without losing the record that it existed. Requires `entity.relationship.update`.

📄️Delete a relationship

Soft-deletes a relationship. Prefer closing its period when the link genuinely ended, so the history stays true. Requires `entity.relationship.delete`.