The increasingly complex multi-partner digital services value chain raises new challenges in terms of ensuring time-to-market, seamless management, cost-effectiveness and revenue sharing.
In order to meet these challenges, TM Forum members including the world’s largest service providers and suppliers, have been working to develop APIs that enable the open digital ecosystem and provide critical management functionality to digital services.
This table contains links to Beta versions of the Open APIs which are available to TM Forum members or API Project Members only.
By default, the information in the table is sorted by API title, but can be re-sorted (for example, by Document Number or Release Version) by clicking on the relevant column headings.
Please note that Comments are no longer permitted on this page. 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 .
To access the API table links below you will need to be logged in
TM Forum Open APIs
Early Adoption (Beta) Versions
TM Forum Open APIs
API User Guide
Sample Implementation Code
|Postman Collection||Release||Version||Lifecycle Status|
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.
Not Yet Available
|Not Yet Available|
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 / authentification method. These credential / authentification methods should be extensible to describe all types of authentification method 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.
Not Yet Available
Not Yet Available
Not Yet Available
Not Yet Available
Not Yet Available
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 thru CRUD operations.
|TMF662||Not Yet Available||Not Yet Available||Not Yet Available|
Entity Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory.
The Entity Inventory API can be used to query the Entity and Association instances.
The Entity Inventory API can be called by an order management system to create new Entity/Association instances or update existing Entity/Association instances in the Entity Inventory.
|TMF703||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
Event Management API
The Event Management API provides a standardized client interface to the enterprise event management system for creating, managing and receiving service related events to (indicatively) drive automation workflows, notify other service providers for service outages and SLA violations, trigger Trouble Ticket creation, and enable more complex orchestration scenarios between management systems. The Event Management API can also be used to convey business level Events in support of other processes.
|TMF688||Not Yet Available||Not Yet Available||Not Yet Available|
Federated Identity API
The management of principals of any kind (persons, objects, …) and their access to resources in an open environment which can span across different enterprise boundaries. It relies on authentication, authorization and consent mechanisms to protect privacy with a simple and easy user experience. Different parties can provide identity services (operators, social networks, GSMA, …).
|TMF691||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
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.
|TMF673||Not Yet Available||Not Yet Available||Not Yet Available|
Geographic Location Management API
Provides the information of a geographic region of the entity (customer, equipment, address).
|TMF675||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
IoT Device Management API Component Suite
In addition to including established TM Forum Open APIs, such as alarm management, resource management and activation APIs, the IoT Device Management API Component Suite also includes an IoT Data Access Endpoint API. This API allows for IoT data access using different types of protocols (MQTT IoT, CoAP, etc.). It encapsulates the protocols and allows devices to be easily integrated into solutions that support a host of IoT initiatives, including smart cities, smart factories and other vertical markets.
|TMF908||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
IoT Service Management API Component Suite
The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale.
|TMF914||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
Payment Method 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.
|TMF670||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
Performance Management API
Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance.
|TMF628||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
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
|TMF671||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
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 omni-channel.
|TMF680||Not Yet Available||Not Yet Available||Not Yet Available|
Resource Activation and Configuration 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.
|TMF702||Not Yet Available||Not Yet Available||Not Yet Available|
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.
Resource Function Activation and Configuration 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
|TMF664||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
Risk Management API
The Risk Management API allows the retrieval of Risk Assessments during interaction with PartyRoles (individualsor 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.
|TMF696||Not Yet Available||Not Yet Available||21.0.0||4.0.0||Pre-production|
Service Catalog API
The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.
Service Ordering Management API
The REST API for Service Order Management provides a standardized mechanism for placing a service order with all of the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications.
Service Problem Management
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.
|TMF656||Not Yet Available||Not Yet Available||Not Yet Available|
Service Quality 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.
|TMF657||Not Yet Available|
Shipping Order Management API
Provides the necessary functionality to create, update and query Shipping Orders. A Shipping Order is a document used by a business to specify what items are to be transferred from a storage location or warehouse to which person and to which new location. A ShippingOrder typically is sent along with a shipment of goods so that the person receiving them can verify that the document correctly reflects the items that they actually received.
|TMF700||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
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.
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.
|TMF677||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available||Not Yet Available|
User Roles & Permissions 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.
|TMF672||Not Yet Available||Not Yet Available|
Note: Reference/Sample implementation is not an architecture direction but a sample in a sandbox