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 _____________________________________ |
Document Number | Swagger (Apache 2.0 or RAND) |
API User Guide / Specification (RAND) |
Conformance Profile (RAND) |
CTK | Sample Implementation Code |
Postman Collection | Release | Swagger Version | Publication Date | ODA Domain | 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 |
TMF666 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
21.5.0
|
v4.1.0
|
10-Jan-2022 | Business Partner, Customer | ||
Async Trouble Ticket API Async API Enabled for Trouble Ticket, Async API conpect supporting the event-based architecture |
TMF925 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v4.0.0
|
Common | |||
Change Management API The Change Management API provides the standard integration capabilities between external applications and Change Management Application |
TMF655 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
|
v4.0.0
|
10-Jan-2022 | Common | ||
Customer360 Management API An API to give a consolidated Customer overview. This is a view-only API, based on the various underlying involved TM Forum Open APIs. This API provides references where one can find detailed information for: Account, Agreement, Appointment, CustomerBill, InteractionItem, LoyaltyBalance, ProductOrder, ProductValue, Promotion, Quote, ServiceProblem, TroubleTicket, UsageSpecification |
TMF717 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
21.5.0
|
v4.0.0
|
05-Jan-2022 | Customer | ||
DCS 5GSlice Service Activation API Domain Context Specialization of TMF640 for 5G Service Slice, Swagger of Contract is strongly bound to the GSMA Service Definition |
TMF924 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v4.0.0
|
Service | |||
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. |
TMF720 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Business Partner, Common | ||
Dunning Case Management No description available yet |
TMF728 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v4.0.0
|
Common | |||
Entity Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory. |
TMF703 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Common | ||
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 |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Common | ||||
Federated ID Management 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 |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Common | |||
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 |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Common | ||
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 | Not yet available |
22.5.0
|
v5.0.0
|
Common | ||||
Intent The Component Suite for Intent Management API defines the set of operations that should be offered to manage intent and intent-driven interactions in a consistent manner. |
TMF921 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
22.0.0
|
v4.0.0
|
08-06-2022 | |||
IoT Agent and Device Management API 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 |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Resource | |||
IoT Service Management API 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 |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Product, Common, Resource, Service | |||
Metadata Catalog Management API Metadata Catalog |
TMF725 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
|
v4.0.0
|
10-Jan-2022 | Common | ||
Network as a Service Management API The API Component Suite supports of a set of Operational Domains exposing and managing “Network” Services. These services are referred to as Network as a Service (NaaS) and include all services offered from a service provider including connectivity, end points, media services, etc. |
TMF909 | Not yet available | Not yet available | Not yet available | Not yet available |
18.5.1
|
v4.2.0
|
Common, Product, Service | ||||
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. |
TMF669 | Not yet available | Not yet available | Not yet available |
22.0.0
|
v4.1.0
|
08-06-2022 | Business Partner | ||||
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. |
TMF670 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
21.5.0
|
v4.1.0
|
22-Nov-2021 | Customer | ||
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 |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Service, Common | ||
Process Flow Management API The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action: |
TMF701 | Not yet available | Not yet available | Not yet available |
19.0.1
|
v4.1.0
|
22-Nov-2021 | Common | ||||
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. |
TMF620 | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v5.0.0
|
Product | ||||
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. |
TMF637 | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v5.0.0
|
Product | ||||
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. |
TMF679 | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v5.0.0
|
Product | ||||
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. |
TMF622 | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v5.0.0
|
Customer, Product | ||||
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 |
TMF671 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Product | ||
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. |
TMF648 | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v5.0.0
|
Customer | ||||
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. |
TMF680 | Not yet available | Not yet available | Not yet available |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Customer | ||||
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. |
TMF702 |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Resource, Common | |||||||
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 |
22.0.0
|
v4.0.0
|
08-06-2022 | Resource, Common | |||
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. |
TMF699 | Not yet available | Not yet available | Not yet available | Not yet available |
22.0.0
|
v4.1.0
|
08-06-2022 | MarketingSales | |||
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. |
TMF640 | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v5.0.0
|
Common, Service | ||||
Service Catalog Management API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. |
TMF633 | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v5.0.0
|
Service | ||||
Service Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory. |
TMF638 | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v5.0.0
|
Service | ||||
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. |
TMF641 | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v5.0.0
|
Service | ||||
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. |
TMF653 | Not yet available | Not yet available | Not yet available | Not yet available |
21.5.0
|
v5.0.0
|
10-Dec-2021 | Service | |||
Service Usage Management API No description available yet |
TMF727 | Not yet available | Not yet available | Not yet available | Not yet available |
22.0.0
|
v4.0.0
|
08-06-2022 | ||||
Shipment Management Management API Shipment Management |
TMF711 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
|
v4.0.0
|
10-Jan-2022 | Business Partner | ||
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 |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Business Partner | ||||
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 | Not yet available | Not yet available | Not yet available |
22.0.0
|
v4.0.0
|
08-06-2022 | Business Partner | ||
Stock Management No description available yet |
TMF687 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.2
|
v4.1.0
|
16-11-2022 | Common | ||
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). |
TMF621 | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v4.1.0
|
Common | ||||
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 |
21.5.0
|
v4.0.0
|
22-Nov-2021 | Product | ||
Warranty Management No description available yet |
TMF715 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v4.0.0
|
Common | |||
Work Management No description available yet |
TMF713 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v4.0.0
|
Common | |||
Work Order Management API The Work Order API performs the following operations on a workOrder resource: |
TMF697 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
|
v4.0.0
|
22-Nov-2021 | Business Partner | ||
Work Qualification Management No description available yet |
TMF714 | Not yet available | Not yet available | Not yet available | Not yet available | Not yet available |
22.5.0
|
v4.0.0
|
Common |
Note: Reference/Sample implementation is not an architecture direction but a sample in a sandbox