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

GET /api/organizations
Returns organizations the authenticated user belongs to.
ParameterTypeDescription
pagequeryPage number (default: 1)
pageSizequeryItems per page (default: 20)
searchquerySearch by name or slug
Authentication: User authentication required.

​
Get organization

GET /api/organizations/{id}
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

GET /api/organizations/{id}/storage-config
Returns the organization’s storage mode and configuration (Synthetiq-managed or external). Authentication: Organization member required.

​
Update storage config

POST /api/organizations/{id}/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

GET /api/organizations/{id}/store
ParameterTypeDescription
typequeryFilter by entity type: app, service, chat_extension
Authentication: Organization member or public store access.

​
Publish to store

POST /api/organizations/{id}/store
ParameterTypeRequiredDescription
entityIdbodyYesEntity to publish
isPublicbodyNoMake visible outside the organization
Authentication: Organization member + entities:share_store scope + entity publisher access.

​
Remove from store

DELETE /api/organizations/{id}/store
ParameterTypeRequiredDescription
entityIdbodyYesEntity to unpublish
Authentication: Organization member + entities:share_store scope + entity publisher access.

​
Get publication details

GET /api/organizations/{id}/store/{publicationId}
Authentication: Organization member or public access.

​
Update publication

PATCH /api/organizations/{id}/store/{publicationId}
ParameterTypeDescription
isPublicbodyUpdate public visibility
Authentication: Organization member + entities:share_store scope.

​
Delete publication

DELETE /api/organizations/{id}/store/{publicationId}
Authentication: Organization member + entities:share_store scope.

​
List public stores

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