Appointment Management API

REST API

Overview

An Appointment is an arrangement for service provider personnel to carry out some activity at a particular time and place, typically (but not exclusively) at customer premises. It could be used to install a product service, deliver a product order item or solve a customer problem. This API provides the interface for managing Appointments.


Version history

v5.0.0

15-July-2026 TMF646 v5.0.0 RC1 Preview release: Open API Specification (OAS), User Guide, Conformance Profile, and Postman Collection. This release provides an updated v5.0.0 preview of the Document Management API, aligned with the latest TM Forum Open API standards and includes a Postman Collection.

v4.0.0

15-May-2026 – CTK updated docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments. README files have been updated to document proxy configuration.

07-Nov-2024 TMF646 v4.0.0 CTK file fix Mac-Linux-RUNCTK.sh modified to remove syntax errors. No impact to awarded Open API Conformance certifications.

API No.

TMF646

Stable version

v4.0

This Version

v4.0

Types

RESTful

DOMAIN

Customer

IPR MODE

Apache 2.0 unless stated

Release Date

15 May 2026

API assets v4.0

Swagger

OPEN API SPECIFICATION

Postman collection

Postman collection

API user guide / specification

API USER GUIDE (RAND)

Sample implementation code

Sample implementation code

CTK

CTK

Conformance profile

Conformance Profile (RAND)

Components

ODA Components are the software building blocks of a cloud native digital service provider’s network and IT systems, designed for plug-and-play interoperability in a standardized deployment environment (the ODA Canvas). This is a list of ODA Components that expose this API either as a Mandatory or Optional API.