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 the latest Production versions. For Pre-production versions see Open API Table - Pre-production (Beta).
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
TM Forum Open APIs
(Apache 2.0 or RAND)
Reference Implementation Code
|Postman Collection||Release||Lifecycle Status|
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
Agreement Management API
The Agreement API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners.
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.
|TMF642||Not yet available||Not yet available||Not yet available||17.0.1||Production|
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.
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.
Not yet available
|Not yet available||Not yet available||18.0.1||Production|
Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users.
|TMF681||Not yet available||Not yet available||Not yet available||18.0.1||Production|
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.
|TMF678||Not yet available||Not yet available||Not yet available||17.5.1||Production|
Customer Management API
Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.
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
|TMF667||Not yet available||Not yet available||17.0.1||Production|
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||17.0.1||Production|
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||18.0.1||Production|
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||17.5.1||Production|
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||17.5.1||Production|
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?”
|TMF674||Not yet available||Not yet available||Not yet available||17.5.1||Production|
Loyalty Management API
Supports the management of loyalty program specifications, loyalty program members, their associated products and loyalty accounts with loyalty balances
|TMF658||Not yet available||Not yet available||17.0.1||Production|
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 a 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.
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.
|TMF683||Not yet available||Not yet available||Not yet available||18.0.1||Production|
Party Management API
Provides a standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events.
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.
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.
|TMF676||Not yet available||Not yet available||Not yet available||18.0.1||Production|
Payment Methods 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.
Not yet available
|Not yet available||17.5.1||Production|
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||14.5.1||Production|
Performance Management Threshold API
Provides a standardized mechanism for performance management such as creation, partial or full update and retrieval of the resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It allows also notification of events related to performance
|TMF649||Not yet available||Not yet available||Not yet available||Not yet available||17.0.1||Production|
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.
Not yet available
|Not yet available||17.0.1||Production|
Process Flow Management API
The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:
Not yet available
Not yet available
Not yet available
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.
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.
Product Offering Qualification 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.
Product Ordering API
Provides a standardized mechanism for placing a product order with all of 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.
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||18.0.1||Production|
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 of the necessary quote parameters.
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||18.0.1||Production|
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.
|TMF634||Not yet available||Not yet available||Not yet available||17.0.1||Production|
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||17.5.1||Production|
Resource Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.
|TMF639||Not yet available||Not yet available||17.0.1||Production|
Resource Ordering 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.
|TMF652||Not yet available||Not yet available||Not yet available||Not yet available||16.5.1||Production|
Resource Pool Management API
Resource Pool management API provides a feature of resource reservation at pre-order phase. In order to reserve a physical product, logical product, and virtual product, the API uses the idea of a resource pool.
|TMF685||Not yet available||Not yet available||Not yet available||18.0.1||Production|
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.
Service Activation and Configuration 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.
Service Catalog API
The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.
Service Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.
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.
Service Qualification API
Service Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location.
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||Not yet available||Not yet available||18.0.1||Production|
Service Test Management API
The Service Test API provides a standardized mechanism for placing a service test with all of 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.
Shipment Tracking API
Shipment Tracking captures information about the current status of the shipment, the past checkpoints and the estimated arrival date. Via this API, tracking information can be retrieved by providing an order Id or the shipping company’s tracking id.
|TMF684||Not yet available||Not yet available||Not yet available||18.0.1||Production|
Shopping Cart 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.
SLA Management API
Provides a standardized interface for Service Level Agreement (SLA) life-cycle Management (SLA Negotiation, SLA configuration SLA Activation/enforcement, SLA Operations, SLA violation / consequence handling, SLA reporting) between a Customer and a Service Provider which provides offers (product with attached SLA in its catalogue) the customer can discover, browse, trigger and order.
|TMF623||Not yet available||Not yet available||14.5.1||Production|
Trouble Ticket 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).
Usage Consumption Management API
This API should allow viewing in real-time the balance of the various buckets (SMS, Voice, Data for example) that a user consumes with each of his devices and the usages done out of the bucket. A usage report retrieves the data related to these balances. This API should also allow performing a direct top-up on the balance of a prepaid bucket with voucher references or with a given credit value after a payment done by a credit card or with a credit value transfer.
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.
|TMF635||Not yet available||Not yet available||14.5.1||Production|
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||Not yet available||17.0.1||Production|