logo

Open API table

This table contains the latest Production versions of the Open APIs, for which TM Forum provides conformance certification. For APIs in early adoption or still in development please click here. For previous versions which are no longer supported please click here.

If you have any questions regarding the content of the Open API table please post them as discussion topics on the Open API Community Forum.

TM Forum Open APIssorted ascendingODA domainDocument numberVersionPublication dateNotes

AI Management API

The API Component Suite for AI Management defines the set of operations that should be offered in order that a Service Provider can govern Artificial Intelligence systems deployed at scale. Effective governance and management of AI must span the lifecycle from design through deployment and eventual withdrawal from service. However, the initial focus of the AI Management API is restricted to the in-life aspects of AI and in particular on the management of ‘model contracts’.

Business Partner, Resource, CommonTMF915v4.0.001-Jul-2021

No notes

Account Management API

Provides standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts

Business Partner, CustomerTMF666v4.0.001-Jul-2021

No notes

Account Management API

Provides standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts

Business Partner, CustomerTMF666v5.0.019-Sep-23

No notes

Agreement Management API

The Agreement API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners.

Business PartnerTMF651v4.0.001-Jul-2021

No notes

Alarm Management API

The Alarm Management API applies lessons that were learned in previous generations of similar APIs that were implemented in the Telecommunication industry, starting from ITU recommendations, TM Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment initiative between 3GPP and TM Forum interfaces, and the more recent ETSI work on requirements for NFV interfaces.

ResourceTMF642v4.0.009-Jul-2021

No notes

Alarm Management API

The Alarm Management API applies lessons that were learned in previous generations of similar APIs that were implemented in the Telecommunication industry, starting from ITU recommendations, TM Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment initiative between 3GPP and TM Forum interfaces, and the more recent ETSI work on requirements for NFV interfaces.

ResourceTMF642v5.0.019-Sep-23

No notes

Appointment Management API

The appointment API provides a standardized mechanism to book an appointment with all the necessary appointment characteristics. The API allows searching of free slots based on parameters, as for example a party, then creating the appointment. The appointment has characteristics such as nature of appointment, place of appointment.

CustomerTMF646v4.0.001-Jul-2021

No notes

CDR Transaction Management API

CDR Transaction Management API goal is to provide the ability to manage a CDR Transaction. This CDR Transaction managing CDR Transactions that define how revenue share is calculated, billed and paid between an enterprise with one or more other parties.

CommonTMF735v5.0.019-Sep-23

No notes

Change Management API

The Change Management API provides standard integration capabilities between external applications and Change Management Application. The API consists of a simple set of operations that interact with a Change Request in a consistent manner.

CommonTMF655v4.0.024-Jan-2022

No notes

Communication Management API

Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users.

CommonTMF681v4.0.001-Jul-2021

No notes

Customer Bill Management API

This API allows operations to find and retrieve one or several customer bills (also called invoices) produced for a customer also allows operations to find and retrieve the details of applied customer billing rates presented on a customer bill.

CustomerTMF678v4.0.001-Jul-2021

No notes

Customer Bill Management API

This API allows operations to find and retrieve one or several customer bills (also called invoices) produced for a customer also allows operations to find and retrieve the details of applied customer billing rates presented on a customer bill.

CustomerTMF678v5.0.019-Sep-23

No notes

Customer Management API

Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.

CustomerTMF629v4.0.001-Jul-2021

No notes

Customer Management API

Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.

CustomerTMF629v5.0.019-Sep-23

No notes

Digital Identity Management API

Provides the ability to manage a digital identity. This digital identity allows identification of an individual, a resource, or a partyRole (a specific role - or set of roles - for a given individual). A digital identity is associated with credential / authentication method. These credential / authentication methods should be extensible to describe all types of authentication methods such as login/password, biometric, token, etc. A contact medium is also associated with digital identity (or directly at credential level) to manage credential recovery UCs.

Business Partner, CommonTMF720v4.0.024-Jan-2022

No notes

Document Management API

Provides the operations to synchronize documents and document versions across systems. It also provides operations for uploading documents by Users as well as for viewing of documents online

CommonTMF667v4.0.0

No notes

Entity Catalog Management API

The entity catalog is intended to provide any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. The API provides management of the entity specifications and their associations through CRUD operations.

CommonTMF662v4.0.027-Sep-2021

No notes

General Test Artifact Management API

This API provides a standardized mechanism for the management of test artefacts that do not fall into the categories managed by TMF704, TMF705, TMF706, TMF707, or TMF709, such as binaries, jars, etc.

CommonTMF710v4.0.030-Jun-2021

No notes

Geographic Address Management API

Provides a standardized client interface to an Address management system. It allows looking for worldwide addresses. It can also be used to validate geographic address data, to be sure that it corresponds to a real geographic address. Finally, it can be used to look for a geographic address by: searching an area as a start (city, town ...), then zooming on the streets of this area, and finally listing all the street segments (numbers) in a street.

CommonTMF673v4.0.002-Jul-2021

No notes

Geographic Site Management API

Covers the operations to manage (create, read, delete) sites that can be associated with a customer, account, service delivery or other entities. This API defines a Site as a convenience class that allows easy reference to places important to other entities, where a geographic place is an entity that can answer the question “where?”

CommonTMF674v4.0.001-Jul-2021

No notes

Incident Management API

The Incident Management API provides a standardized mechanism to report, diagnose and resolve incidents and manages the entire lifecycle of incidents as defined by ITIL. The primary objective of incident management is to restore normal service operation as quickly as possible and minimize the adverse impact on business operations, ensuring that agreed levels of service quality are maintained.

CommonTMF724v4.0.009-03-2023

No notes

Intent Management API

This API allows intents to be expressed, reporting on and negotiated between the intent owner and the intent handler. The Intent API provides specifies the basic attributes and relationships that describe an Intent. The expression attribute of Intent contains a statement of the expectations for an intent in a particular ontology language and is validated by the TM Forum Intent Ontology (TIO).

CommonTMF921v4.0.009-03-2023

No notes

Open Gateway Onboarding and Ordering Component Suite

API Ordering, Developer & Application Onboarding and Management This Operate API component suite covers the onboarding operations between Channel Partners and Operators as described in the GSMA Playbook. It offers a consolidation of multiple TMForum-based APIs into a single endpoint (a component suite). This API focusses on - Developer Management (acceptance, on boarding, lifecycle management)- Application Management (acceptance, on boarding, lifecycle management)- API Service Management (ordering, retrieving).

CommonTMF931v5.0.021-Feb-2024

CAMARA / Open Gateway

Partnership Type Management API

Standardized mechanisms for creating partnership types. It is one of the APIs involved in an onboarding process. Identifies a type of partnership between parties, including the list of role types that are permitted (i.e. Buyer, Seller, Developer). Role types may refer to agreement specifications to be signed by parties playing the role. The API allows the retrieval, creation, update, and deletion of partnership type and its owned sub-resources.

Business PartnerTMF668v4.0.030-Jun-2021

No notes

Party Interaction Management API

A User Interaction captures information about past interactions in order to re-use it in future ones. This allows agents to serve users better by knowing the steps they went through. It also allows customers to see better the actions they have performed and how they interacted with us.

Business PartnerTMF683v4.0.001-Jul-2021

No notes

Party Interaction Management API

A User Interaction captures information about past interactions in order to re-use it in future ones. This allows agents to serve users better by knowing the steps they went through. It also allows customers to see better the actions they have performed and how they interacted with us.

Business PartnerTMF683v5.0.019-Sep-23

No notes

Party Management API

Provides a standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events.Party can be an individual or an organization that has any kind of relationship with the enterprise.

Business PartnerTMF632v4.0.001-Jul-2021

No notes

Party Management API

Provides a standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events.Party can be an individual or an organization that has any kind of relationship with the enterprise.

Business PartnerTMF632v5.0.019-Sep-23

No notes

Party Role Management API

A standardized mechanism for general party roles and includes operations such as creation, update, retrieval, deletion and notification of events. Notice that for the management of customers there is a specific Customer Management API.Party Role management API manages the following data resources: PartyRole

Business PartnerTMF669v4.0.001-Jul-2021

No notes

Party Role Management API

A standardized mechanism for general party roles and includes operations such as creation, update, retrieval, deletion and notification of events. Notice that for the management of customers there is a specific Customer Management API.Party Role management API manages the following data resources: PartyRole

Business PartnerTMF669v5.0.019-Sep-23

No notes

Payment Management API

The Payments API provides the standardized client interface to Payment Systems for notifying about performed payments or refunds. Examples of Payment API originators (clients) include Web servers, mobile app servers, Contact center dashboards or retail store systems. 

CustomerTMF676v4.0.001-Jul-2021

No notes

Payment Method Management API

This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer.

CustomerTMF670v4.0.0

No notes

Prepay Balance Management API

REST API for Balance Management. It includes the model definition as well as all available operations for prepay balance management. Prepaid subscribers pay fees before using services. Therefore, the subscribers must have sufficient balances. Operators can provide multiple recharge channels for subscribers. Subscribers can pass credit between different subscriptions, therefore transferring the balance from one account to another.

CustomerTMF654v4.0.001-Jul-2021

No notes

Privacy Management API

The Privacy management API provides a standardized mechanism for privacy profile types, privacy profiles and privacy agreements such as creation, update, retrieval, deletion and notification of events

Business PartnerTMF644v4.0.001-Jul-2021

No notes

Privacy Management API

The Privacy management API provides a standardized mechanism for privacy profile types, privacy profiles and privacy agreements such as creation, update, retrieval, deletion and notification of events

Business PartnerTMF644v5.0.019-Sep-23

No notes

Product Catalog Management API

Provides a standardized solution for rapidly adding partners’ products to an existing Catalog. It brings the capability for Service Providers to directly feed partners systems with the technical description of the products they propose to them. 

ProductTMF620v5.0.002-Jul-2021

No notes

Product Catalog Management API

Provides a standardized solution for rapidly adding partners’ products to an existing Catalog. It brings the capability for Service Providers to directly feed partners systems with the technical description of the products they propose to them. 

ProductTMF620v4.1.019-Sep-23

No notes

Product Configuration Management API

The Product Configuration API drives the configuration of new product offerings and modification of existing products for various user engagement channels. The Product Configuration API uses product catalog data, policy data, and existing product inventory data to assist engagement managent systems with product configuration. Product configuration may include setting and restrincting characteristic values, enforcing min/max on bundle offering groups and options, and calculation of prices and discounts.

CustomerTMF760v5.0.019-Sep-23

No notes

Product Inventory Management API

Provides standardized mechanism for product inventory management such as creation, partial or full update and retrieval of the representation of a product in the inventory. It also allows the notification of events related to product lifecycle.

ProductTMF637v4.0.001-Jul-2021

No notes

Product Inventory Management API

Provides standardized mechanism for product inventory management such as creation, partial or full update and retrieval of the representation of a product in the inventory. It also allows the notification of events related to product lifecycle.

ProductTMF637v5.0.019-Sep-23

No notes

Product Offering Qualification Management API

Product Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility.

ProductTMF679v4.0.001-Jul-2021

No notes

Product Ordering Management API

Provides a standardized mechanism for placing a product order with all the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order negotiation systems in a consistent manner. A product order is created based on a product offering that is defined in a catalog. The product offering identifies the product or set of products that are available to a customer and includes characteristics such as pricing, product options and market.

Customer, ProductTMF622v4.0.001-Jul-2021

No notes

Product Ordering Management API

Provides a standardized mechanism for placing a product order with all the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order negotiation systems in a consistent manner. A product order is created based on a product offering that is defined in a catalog. The product offering identifies the product or set of products that are available to a customer and includes characteristics such as pricing, product options and market.

Customer, ProductTMF622v5.0.019-Sep-23

No notes

Promotion Management API

Used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit

ProductTMF671v4.1.018-Oct-2021

No notes

Quote Management API

The Quote API is one of the Pre-Ordering Management APIs. The customer Quote API provides a standardized mechanism for placing a customer quote with all the necessary quote parameters.

CustomerTMF648v4.0.001-Jul-2021

No notes

Recommendation Management API

Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omnichannel.

CustomerTMF680v4.0.002-Jul-2021

No notes

Resource Activation Management API

The Resource Activation and Configuration API can be used to query resource instances to acquire the resource activation states and attributes, and it can be used to create/update, configure and activate the resource instances.

Resource, CommonTMF702v4.0.0

No notes

Resource Catalog Management API

The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering process.

ResourceTMF634v5.0.019-Sep-23

No notes

Resource Catalog Management API

The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering process.

ResourceTMF634v4.1.002-Jul-2021

No notes

Resource Function Activation Management API

This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function

Resource, CommonTMF664v4.0.003-Sep-2021

No notes

Resource Inventory Management API

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.

ResourceTMF639v4.0.001-Jul-2021

No notes

Resource Order Management API

The REST API for Resource Order Management. It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Resource Orders (including filtering). A Resource Order API provides a standard mechanism for placing a Resource Order with all necessary order parameters.

ResourceTMF652v4.0.030-Jun-2021

No notes

Revenue Sharing Algorithm Management API

Revenue Sharing Algorithm Management API goal is to provide the Algorithm to calculate a revenue share.

CommonTMF736v5.0.019-Sep-23

No notes

Revenue Sharing Model Management

Revenue Sharing Model Management API goal is to provide the ability to manage a revenue sharing model. This revenue sharing model allows to contain revenue sharing models that define how revenue is shared by an enterprise with one or more other parties.

CustomerTMF738v5.0.019-Sep-23

No notes

Revenue Sharing Report Management API

Revenue Sharing Report Management API goal is to provide the report of a revenue sharing.

CustomerTMF737v5.0.019-Sep-23

No notes

Risk Management API

The Risk Management API allows the retrieval of Risk Assessments during interaction with PartyRoles (individuals or organizations) typically engaged in an Order process from ProviderPartyRole. The Risk Assessment request is usually issued by the ProviderPartyRole (e.g. Service Provider). The resources used to retrieve these assessment are Task resources, as per the Open API guidelines for tasks

CommonTMF696v4.0.021-Dec-23

No notes

Sales Management API

The Sales Management API provides interfaces for Sales Lead, Sales Opportunity, Sales Quote and the other management capabilities to support the sales activities to build relationship with the prospect customer who could be a person or organization that has an interest in the goods and/or services and possibly become the actual customers with one or more subscriptions.

MarketingSalesTMF699v4.0.001-Jul-2021

No notes

Service Activation Management API

The REST API for Activation and Configuration allows the user to retrieve, create, update, delete services and retrieve the monitor resource used to monitor the execution of asynchronous requests on a specific resource. Although all the examples given in the API specification are relative to Services, the same API can be used to Activate and Configure Services or Resources.

Common, ServiceTMF640v4.0.001-Jul-2021

No notes

Service Catalog Management API

The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.

ServiceTMF633v4.0.007-Jul-2021

No notes

Service Inventory Management API

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.

ServiceTMF638v4.0.001-Jul-2021

No notes

Service Inventory Management API

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.

ServiceTMF638v5.0.019-Sep-23

No notes

Service Ordering Management API

The REST API for Service Order Management provides a standardized mechanism for placing a service order with all the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications.

ServiceTMF641v4.1.001-Jul-2021

No notes

Service Problem Management API

The SPM API is used to manage service problems. Service problems are generated based on the information declared by a partner or the event information notified from infrastructure providers. The event information includes alarm information, performance anomaly information, trouble ticket information, SLA violation, maintenance information, and prediction information.

ServiceTMF656v4.0.002-Jul-2021

No notes

Service Qualification Management API

Service Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location.

ServiceTMF645v4.0.001-Jul-2021

No notes

Service Quality Management Management API

Through this API, any Enterprise is able to access a Service Quality Management application and extract Service Level Specifications and associated Service Level Objectives (SLO) and their thresholds.

ServiceTMF657v4.0.022-Sep-2021

No notes

Service Test Management API

The Service Test API provides a standardized mechanism for placing a service test with all the necessary test parameters. The API consists of a simple set of operations that interact with CRM/Service Management systems in a consistent manner. A service test is a procedure intended to check the quality, performance, or reliability of a service.

ServiceTMF653v4.2.001-Jul-2021

No notes

Shopping Cart Management API

A standardized mechanism for the management of shopping carts. Including creation, update, retrieval, deletion and notification of an event. Shopping Cart entity is used for the temporary selection and reservation of product offerings in e-commerce and retail purchase.

CustomerTMF663v4.0.001-Jul-2021

No notes

Shopping Cart Management API

A standardized mechanism for the management of shopping carts. Including creation, update, retrieval, deletion and notification of an event. Shopping Cart entity is used for the temporary selection and reservation of product offerings in e-commerce and retail purchase.

CustomerTMF663v5.0.019-Sep-23

No notes

Software And Compute Management API

This API Suite introduces schemas mapping the Software and Compute ABE to the Open API data model. The intention is to normalize this pattern for managing software resources such as ODA Components, VNFs and cloud native functions (CNF). The existing Resource domain APIs for Catalog (634), Inventory (639), Activation (664, 702) and Ordering (652) should be used with these extentions of Resource/ResourceSpecification however the TMF730 API, with it's swagger and User Guide makes the data model published and available.

CommonTMF730v4.0.015-Dec-23

No notes

Stock Management API

The Stock Management API provides standardized mechanism for product stock management such as creation, update and retrieval of the representation of a product stock, reserve product stock, check or query product stock or adjust product stock. It also allows the notification of events related to them.

ResourceTMF687v4.0.030-Jun-2021

No notes

Test Case Management API

This API provides a standardized mechanism for the management of test artefacts that do not fall into the categories managed by TMF704, TMF705, TMF706, TMF707, or TMF709, such as binaries, jars, etc.

CommonTMF704v4.0.030-Jun-2021

No notes

Test Data Management API

This API provides a standardized mechanism for the management of test data artefacts used for test case parameterization. These include Test Data Schemas and Test Data Instances.

CommonTMF706v4.0.030-Jun-2021

No notes

Test Environment Management API

This API provides a standardized mechanism for the management of test artefacts related to test environment specification. These include Abstract Test Environments, Concrete Environment Metamodels used to map abstract environments to concrete test resources, Environment Provisioning Artefacts, and Test Resource APIs exposed to test cases.

CommonTMF705v4.0.030-Jun-2021

No notes

Test Execution Management API

This API provides a standardized mechanism for test case, test suite, and non-functional test model execution. This also includes allocation and provisioning of test environments for test execution.

CommonTMF708v4.0.007-Jul-2021

No notes

Test Result Management API

This API provides a standardized mechanism for the management of test results. These include Test Case Results, Test Suite Results, and Non-functional Test Results.pro

CommonTMF707v4.0.030-Jun-2021

No notes

Test Scenario Management API

This API provides a standardized mechanism for the management of test scenarios. Test scenarios provide a full specification of required test elements, e.g. Test Case T parameterized with test data instance D running on abstract test environment E provisioned with a set of provisioning artefacts P.

CommonTMF709v4.0.030-Jun-2021

No notes

Trouble Ticket Management API

Provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets among partners as a result of an issue or problem identified by a customer or another system. Examples of Trouble Ticket API clients include CRM applications, network management or fault management systems, or other trouble ticket management systems (e.g. B2B).

CommonTMF621v4.0.001-Jul-2021

No notes

Trouble Ticket Management API

Provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets among partners as a result of an issue or problem identified by a customer or another system. Examples of Trouble Ticket API clients include CRM applications, network management or fault management systems, or other trouble ticket management systems (e.g. B2B).

CommonTMF621v5.0.019-Sep-23

No notes

Usage Consumption Management API

This API provides the real-time value within buckets (SMS, Voice, Data, TV for example) that a customer consumes with each of their devices, related to subscribed communication products without having to wait for the bill cycle. A usage report retrieves the data related to these balances.

ProductTMF677v4.0.001-Jul-2021

No notes

Usage Management API

Provides standardized mechanism for usage management such as creation, update, retrieval, import and export of a collection of usages. The API manages both rated and non-rated usage. For example, it allows a service provider to 1) retrieve usage generated by a partner service platform in order to rate it and 2) to provide rated usage to a partner for consumption follow-up purposes.

ProductTMF635v4.0.001-Jul-2021

No notes

User Role Permission Management API

A user role is defined as the entity that defines a set of privileges covering various functions and/or manageable assets. When a user is assigned a given role then it is actually allocated all the privileges defined for that role type and the corresponding permissions are created for that user.

CommonTMF672v4.0.002-Jul-2021

No notes