Skip to content
Last updated

API & Integration

One Platform API documentation is organized into two API families with different audiences and access rules.

API familyAudienceEndpoint reference
Organizations APIPartners and customer-side system integrators working in an organization scope.Organizations API endpoints
Integrators APINamirial product integrators and internal product integrations.Integrators API endpoints

Organizations API

Use the Organizations API when the integration acts on behalf of a One Platform organization. Most operations are scoped by organizationId and use routes such as:

/v1/organizations/{id}/<resource>

Start from:

Integrators API

Use the Integrators API for integrations reserved to Namirial product teams and approved Namirial integrators. This family exposes broader integration endpoints and is protected by dedicated RBAC.

Start from:

Provisioning

Provisioning documents the dry-run and activation callbacks that One Platform sends to integrated Namirial products during service activation.