OrganizationRelationships
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.
Get all relationships for organization
Gets all of the relationships for a supplied organization ID.
Request
/v1/organizationRelationships
Query parameters
org_id
integer
required
The ID of the organization to get relationships for
Response
OK
Expand all
Copy code- true
- [ ... ]▶
- { ... }▶
- { ... }▶
Get one organization relationship
Finds and returns an organization relationship from its ID.
Request
/v1/organizationRelationships/{id}
Path parameters
id
integer
required
The ID of the organization relationship
Query parameters
org_id
integer
The ID of the base organization for the returned calculated values
Response
OK
Expand allCopy code- true
- { ... }▶
- { ... }▶
Create an organization relationship
Creates and returns an organization relationship.
Request
/v1/organizationRelationships
Body parameters
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.
Response
OK
Expand allCopy code- true
- { ... }▶
- { ... }▶
Update an organization relationship
Updates and returns an organization relationship.
Request
/v1/organizationRelationships/{id}
Path parameters
id
integer
required
The ID of the organization relationship
Body parameters
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.
Response
OK
Expand allCopy code- true
- { ... }▶
- { ... }▶
Delete an organization relationship
Deletes an organization relationship and returns the deleted ID.
Request
/v1/organizationRelationships/{id}
Path parameters
id
integer
required
The ID of the organization relationship
Response
OK
Expand allCopy code- true
- { ... }▶