Identities
An Identity relationship links an Organisation to an identity in a multi-entity setup. It is used when an organisation has multiple legal identities, branches, or representations that need to be tracked separately while remaining connected to the same parent.
Use the Relationship_Organization_Identity endpoint to manage organisation identities. Identities inherit all fields from Relationship.
An Identity (Relationship_Organization_Identity) is a Relationship — it defines a specific identity an organisation holds.
An Organisation (Relation_Organization) is the entity itself — the company record. The Identity links your parent organisation to the child organisation that represents a particular identity.
Endpoints
List Identities
Retrieve a paginated list of organisation identities.
/v1/odata/Relationship_Organization_IdentitySingle Identity
Retrieve a single identity by its ID.
/v1/odata/Relationship_Organization_Identity({id})With expanded relations:
/v1/odata/Relationship_Organization_Identity({id})?$expand=Organization,RelationCreate Identity with a New Organization
Create an identity and its underlying Organisation in one call:
/v1/odata/Relationship_Organization_IdentityRelation.ID— The parent Relation (the main organisation)Organization— The child Organisation representing this identity (created automatically)
Create Identity from an Existing Organization
Link an existing Organisation as an identity:
/v1/odata/Relationship_Organization_IdentityUpdate Identity
Update an existing identity relationship. Provide only the fields to update.
/v1/odata/Relationship_Organization_Identity({id})Delete Identity
Delete an identity relationship by ID. This removes the identity link but does not delete the underlying Organisation.
/v1/odata/Relationship_Organization_Identity({id})Fields
Standard Fields (all entities)
| Field | Type | Description |
|---|---|---|
ID | Guid | Primary key (UUID) |
_Type | String | Entity type discriminator (Relationship.Organization.Identity) |
_Name | String | Computed display name |
SortIndex | Double | Sorting order |
CreationDate | DateTimeOffset | Date the record was created |
LastMutationDate | DateTimeOffset | Date of the last modification |
IsActive | Boolean | Whether the record is active |
IsClosed | Boolean | Whether the record is closed |
Identity Fields
| Field | Type | Description |
|---|---|---|
Name | String | Identity display name |
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| Relation | Relation | N:1 | Parent relation (the main organisation) |
| Organization | Relation.Organization | N:1 | The organisation representing this identity |
| Attachments | Attachment | 1:N | Attached files |
| Notes | Note | 1:N | Notes |
| Labels | Label | 1:N | Labels |
Expanding Relationships
/v1/odata/Relationship_Organization_Identity({id})?$expand=Organization,Relation/v1/odata/Relationship_Organization_Identity?$expand=Relation($select=ID)&$select=NameNavigating Relationships
/v1/odata/Relationship_Organization_Identity({id})/RelationFiltering Examples
/v1/odata/Relationship_Organization_Identity?$filter=contains(Name, '{Name}')&$top={top}/v1/odata/Relationship_Organization_Identity?$filter=CreationDate gt {CreationDate}&$top={top}/v1/odata/Relationship_Organization_Identity?$filter=IsActive eq {IsActive}&$top={top}/v1/odata/Relationship_Organization_Identity?$filter=IsClosed eq {IsClosed}&$top={top}Custom Query
Build your own OData query against Relationship_Organization_Identity. Open Run and edit the whole request inline — swap the entity set, change the $filter, or add $expand, $select, $orderby, $top, $skip. Type $ for suggestions; use ↺ Reset to restore this example.
/v1/odata/Relationship_Organization_Identity?$top=10