Skip to main content

List organizations

GET 
/api/v1/orgs

Retrieve organizations in multiple formats:

  • Paged results (default)
  • Flat list (view=list)
  • Hierarchical tree (view=tree)

Parameters

  • parentOrgId (Guid, optional): retrieve sub-organizations under a specific parent.
  • view (enum, optional): "list", "tree", or "page" (default).
  • skipCount, maxResultCount, sorting: standard paging/sorting fields.
  • sorting: Sorting criteria in the format: 'PropertyName ASC|DESC'. Available properties: name, id.

Responses

  • 200 OK: the shape depends on view. page returns items and totalCount. list returns items only, without totalCount. tree returns an array of root organizations, and each node lists its sub-organizations in children. Security

  • This API requires authentication.

Request​

Responses​

OK