logo

Pre-production Open API table

This table contains APIs in the early adoption or still in development. For Production APIs 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

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.1.010-Jan-2022

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.010-Jan-2022

No notes

Async Trouble Ticket API

Async API Enabled for Trouble Ticket, Async API conpect supporting the event-based architecture

CommonTMF925v4.0.0

No notes

Closed Loop Management

Closedloop formally defines a system of “control mechanisms”, “feed forwards”, “feedback” workflows that altogether operates as a framework in which outputs of the system, workflow or process, are circled back (feedback) and used as inputs to improve future outputs. Please refer to IG1219 for the formal TM Forum definition (also check TMF071).

CommonTMF753v5.0.0

No notes

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

CustomerTMF717v4.0.005-Jan-2022

No notes

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

ServiceTMF924v4.0.0

No notes

Dunning Case Management

No description available yet

CommonTMF728v4.0.0

No notes

Entity Inventory Management API

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

CommonTMF703v4.0.022-Nov-2021

No notes

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.

CommonTMF688v4.0.022-Nov-2021

No notes

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, …).

CommonTMF691v4.0.022-Nov-2021

No notes

Geographic Location Management API

Provides the information of a geographic region of the entity (customer, equipment, address).

CommonTMF675v4.0.022-Nov-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?”

CommonTMF674v5.0.0

No notes

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.

ResourceTMF908v4.0.022-Nov-2021

No notes

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.

Product, Common, Resource, ServiceTMF914v4.0.022-Nov-2021

No notes

Metadata Catalog Management API

Metadata Catalog

CommonTMF725v4.0.010-Jan-2022

No notes

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.

Common, Product, ServiceTMF909v4.2.0

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.0

CAMARA / Open Gateway

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.1.008-06-2022

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.

CustomerTMF670v5.0.022-Nov-2021

No notes

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.

Service, CommonTMF628v4.0.022-Nov-2021

No notes

Performance Thresholding Management 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 hocCollection). It allows also notification of events related to performance

TMF649v4.0.03-12-2022

No notes

Policy Management API

Policy API is designed from SID Policy description. The Policy API is defined from Event-Condition-ActionECA definition: The Event part specifies the signal that triggers the invocation of the rule. The condition part is a logical test that, if satisfied or evaluates to true, causes the action to becarried out. The action part consists of updates or invocations on the local data

CommonTMF723v5.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. Subscriber scan pass credit between different subscriptions, therefore transferring the balance from one account to another.

CustomerTMF654v4.1.017-Feb-23

No notes

Private Optimized Binding

Private Optimized Binding API goal is to provide the ability to connect a User Equipment with a Cloud Application.

CommonTMF759v5.0.0

No notes

Process Flow Management API

The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:

CommonTMF701v5.0.022-Nov-2021

No notes

Process Flow Management API

The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:

CommonTMF701v4.1.022-Nov-2021

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.

ProductTMF679v5.0.0

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.0.022-Nov-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.

CustomerTMF648v5.0.0

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.

ResourceTMF639v5.0.0

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.

MarketingSalesTMF699v5.0.008-06-2022

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.1.008-06-2022

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, ServiceTMF640v5.0.0

No notes

Service Catalog Management API

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

ServiceTMF633v5.0.0

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.

ServiceTMF641v5.0.0

No notes

Service Problem Management API

Service Problem Management API is used to manage problemsin the Service domain.

ServiceTMF656v5.0.0

No notes

Service Qualification Management API

Service Qualification API is one of Pre-Ordering Management API Family. Service Qualification API goal is to provide service technical eligibility.

ServiceTMF645v5.0.0

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.

ServiceTMF653v5.0.010-Dec-2021

No notes

Service Usage Management API

The Service Usage Management API provides a standardized mechanism for service usage management such as the creation, update, retrieval, import and export of a collection of service usages.

TMF727v4.0.008-06-2022

No notes

Service Usage Management API

The Service Usage Management API provides a standardized mechanism for service usage management such as the creation, update, retrieval, import and export of a collection of service usages.

TMF727v5.0.0

No notes

Shipment Management Management API

Shipment Management

Business PartnerTMF711v4.0.010-Jan-2022

No notes

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.

Business PartnerTMF700v4.0.022-Nov-2021

No notes

Topology Management API

No description yet

TMF686v4.0.017-02-2023

No notes

Warranty Management

No description available yet

CommonTMF715v4.0.0

No notes

Work Management

No description available yet

CommonTMF713v4.0.0

No notes

Work Order Management API

The Work Order API performs the following operations on a workOrder resource:

Business PartnerTMF697v4.0.022-Nov-2021

No notes

Work Order Management API

The Work Order API performs the following operations on a workOrder resource:

Business PartnerTMF697v5.0.022-Nov-2021

No notes

Work Qualification Management

No description available yet

CommonTMF714v4.0.0

No notes