Organizations & Users

Manage the organization hierarchy and the users in each organization. Create organizations and sub-organizations, add existing users to an organization, and look up which organizations a user belongs to.

📄️Create an organization

Add a new organization with the provided details.

📄️List organizations

Retrieve organizations in multiple formats:

📄️Get an organization

Retrieve detailed information of an organization by its unique identifier.

📄️Update an organization

Update the name and description of an existing organization.

📄️Delete an organization

Remove an organization by its ID. Requires confirmation of the organization name.

📄️List child organizations

Retrieve child organizations under a given organization up to a specified depth.

📄️List parent organizations

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

📄️Add users to an organization

Associates multiple existing users with an existing organization, assigning the `admin` role to each. All items are validated before any insertion. If any item fails, the entire batch is rejected.

📄️List users in an organization

Retrieve a paginated list of users belonging to a specific organization.

📄️Get a user in an organization

Retrieve detailed information about an organization user by specifying both **orgId** and **userId**.

📄️Remove a user from an organization

Remove a user from an organization by specifying both **orgId** and **userId**.

📄️List users

Retrieve a paginated and sorted list of application users.

📄️Get a user

Retrieve details of a single application user by their unique ID.

📄️List a user's organizations and roles

Returns the organizations the user belongs to, with the user's role in each, as a tree. The response is paged: totalCount counts root organizations, and each item lists its sub-organizations in children. skipCount and maxResultCount apply to root organizations. Sub-organizations under each root are always returned in full and are not limited by paging.