Skip to main content

List parent organizations

GET 
/api/v1/orgs/{orgId}/parents

Retrieve the ancestors of an organization, up to the number of levels set by depth.

Parameters

  • orgId (Guid, required): ID of the organization whose parents you want.
  • depth (int, optional, default=1): Number of parent levels to return above orgId. The default 1 returns only the direct parent.

Responses

  • 200 OK: returns one path as an org tree, ordered from top to bottom. The top node is the highest ancestor reached within depth. It is the root organization only when depth reaches that far. Each node's children holds only the next organization on the path down, and the last node is the requested organization itself. The example shows depth=2.

Request​

Responses​

OK