GET v1/Companies({CompanyId})/Tree?roleDepth={roleDepth}

This Call gets the Company Tree including Locations

Information:

Base URL:

https://api.covasoft.net/entitymanager

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	Company Id from your onboarding package	integer	Required
roleDepth	Optional parmater to get Location level	string	Default value is Location

Body Parameters

None.

Response Information

Resource Description

Returns the Company Tree including Locations

CompanyTreeReturn

Name	Description	Type	Additional information
Nodes		Collection of CompanyTreeReturn	None.
Id		integer	None.
Name		string	None.
DisplayName		string	None.
Description		string	None.
Role		string	None.
ClientEntityId		integer	None.
Version		integer	None.

Response Formats