Organization relationships represent how different organizations are related to each other. The relationship can be hierarchical (parent-child companies) or lateral as defined by the type
field - either parent
or related
.
Gets all of the relationships for a supplied organization ID.
/v1/organizationRelationships
org_id
integer
required
The ID of the organization to get relationships for
OK
Finds and returns an organization relationship from its ID.
/v1/organizationRelationships/{id}
id
integer
required
The ID of the organization relationship
org_id
integer
The ID of the base organization for the returned calculated values
OK
Creates and returns an organization relationship.
/v1/organizationRelationships
application/json
org_id
integer
The ID of the base organization for the returned calculated values
type
string
required
The type of organization relationship
Values
parent
related
rel_owner_org_id
integer
required
The owner of the relationship. If type is parent
, then the owner is the parent and the linked organization is the daughter.
rel_linked_org_id
integer
required
The linked organization in the relationship. If type is parent
, then the linked organization is the daughter.
OK
Updates and returns an organization relationship.
/v1/organizationRelationships/{id}
id
integer
required
The ID of the organization relationship
application/json
org_id
integer
The ID of the base organization for the returned calculated values
type
string
The type of organization relationship
Values
parent
related
rel_owner_org_id
integer
The owner of this relationship. If type is parent
, then the owner is the parent and the linked organization is the daughter.
rel_linked_org_id
integer
The linked organization in this relationship. If type is parent
, then the linked organization is the daughter.
OK
Deletes an organization relationship and returns the deleted ID.
/v1/organizationRelationships/{id}
id
integer
required
The ID of the organization relationship
OK