Skip to main content
Organizations are the top-level container for all platform resources. Each organization has members, roles, entities, a store, and deployment infrastructure.

​
List organizations

Returns organizations the authenticated user belongs to. Authentication: User authentication required.

​
Get organization

Returns organization details including members, roles, and storage configuration. Includes the organization’s NPM registry key if the requesting user belongs to this organization. Authentication: Organization member required.

​
Storage configuration

​
Get storage config

Returns the organization’s storage mode and configuration (Synthetiq-managed or external). Authentication: Organization member required.

​
Update storage config

Configure where entity packages and assets are stored. Authentication: Organization member + org:settings scope.

​
Organization store

The organization store is an internal app store where members can discover and install shared entities.

​
List store publications

Authentication: Organization member or public store access.

​
Publish to store

Authentication: Organization member + entities:share_store scope + entity publisher access.

​
Remove from store

Authentication: Organization member + entities:share_store scope + entity publisher access.

​
Get publication details

Authentication: Organization member or public access.

​
Update publication

Authentication: Organization member + entities:share_store scope.

​
Delete publication

Authentication: Organization member + entities:share_store scope.

​
List public stores

Returns all publicly accessible stores across organizations. Authentication: User authentication required.