{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API Overview","description":"Integration and usage documentation.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-overview","__idx":0},"children":["API Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["One Platform exposes the Organizations API for partners and system integrators that need to integrate with organization-scoped platform capabilities."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API is documented through the OpenAPI specification linked below."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API"},"children":["API"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"OpenAPI file"},"children":["OpenAPI file"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Audience"},"children":["Audience"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/apis/oas/organizations"},"children":["Organizations API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apis/oas/organizations.json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partners and system integrators working on behalf of a One Platform organization."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-scope","__idx":1},"children":["API Scope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Organizations API is scoped by organization."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Most endpoints follow this route pattern:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"/v1/organizations/{id}/<resource>\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{id}"]}," path parameter identifies the One Platform organization context for the request. The access token used by the integration must be allowed to operate on that organization."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"main-capabilities","__idx":2},"children":["Main Capabilities"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API currently covers organization-scoped operations for:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Area"},"children":["Area"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Examples"},"children":["Examples"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business relations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve business relations and related consumer paths."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consumers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve consumers connected to an organization and inspect consumer details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contracts"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create, retrieve, update, and manage organization contracts."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contract items"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create and manage service lines connected to a contract."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service activation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve activation group information and perform activation-related actions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consumptions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve latest and aggregated consumptions for consumers or business relations."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Product metrics"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve product metrics for organization-related consumers."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":3},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API calls use Bearer tokens issued by MyNamirial through OAuth2 Client Credentials."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the authentication flow and token request examples, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/authentication/authentication"},"children":["Authentication"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":4},"children":["Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The One Platform API base URL depends on the target environment and is provided during the integration setup."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Samples in this documentation use:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"ONE_PLATFORM_BASE_URL=\"https://<one-platform-api-host>\"\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the value provided for the environment you are integrating with."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"where-to-go-next","__idx":5},"children":["Where to Go Next"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/authentication/authentication"},"children":["Authentication"]}," - OAuth2 Client Credentials with MyNamirial."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/apis/oas/organizations"},"children":["Organizations API"]}," - OpenAPI reference for partner integrations."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/integration-guides/integration-guides-overview"},"children":["Integration Guides"]}," - task-based integration examples."]}]}]},"headings":[{"value":"API Overview","id":"api-overview","depth":1},{"value":"API Scope","id":"api-scope","depth":2},{"value":"Main Capabilities","id":"main-capabilities","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Base URL","id":"base-url","depth":2},{"value":"Where to Go Next","id":"where-to-go-next","depth":2}],"frontmatter":{"seo":{"title":"API Overview"}},"lastModified":"2026-05-14T13:00:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/api-overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}