How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
TM Forum

TM Forum agreement API

The agreement API from TM Forum — 2 operation(s) for agreement.

Documentation Provider Profile APIs.io OpenAPI GitHub

TM Forum agreement API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agreement. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against a single base URL, https://serverRoot/tmf-api/agreementManagement/v4/.

5 operations 2 paths 15 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Server
https://serverRoot/tmf-api/agreementManagement/v4/
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

agreement 5
GET
/agreement
List or find Agreement objects
listAgreement 3 params → 200400401403404405409500
POST
/agreement
Creates a Agreement
createAgreement body → 201400401403405409500
GET
/agreement/{id}
Retrieves a Agreement by ID
retrieveAgreement 2 params → 200400401403404405409500
PATCH
/agreement/{id}
Updates partially a Agreement
patchAgreement 1 param body → 200400401403404405409500
DELETE
/agreement/{id}
Deletes a Agreement
deleteAgreement 1 param → 204400401403404405409500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Agreement (21 properties), Agreement_Create (19 properties), Agreement_Update (18 properties), AgreementSpecificationRef (8 properties). Each schema is shown below with its type and property counts.

Agreement
object
An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer p…
21 properties 4 required
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
ProductOfferingRef
object
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing informati…
7 properties 1 required
Any
Agreement_Update
object
An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer p…
18 properties 4 required
Agreement_Create
object
An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer p…
19 properties 4 required
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
6 properties 2 required
AgreementRef
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
7 properties 1 required
AgreementSpecificationRef
object
AgreementSpecification reference. An AgreementSpecification represents a template of an agreement that can be used when establishing partnerships.
8 properties 1 required
ProductRef
object
7 properties 1 required
AgreementAuthorization
object
A business participant that is responsible for approving the agreement.
6 properties
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
AgreementItem
object
A part of the agreement expressed in terms of a product offering and possibly including specific terms and conditions.
6 properties
AgreementTermOrCondition
object
Aspects of the agreement not formally specified elsewhere in the agreement and that cannot be captured elsewhere in a formal notation, or automatically monitor…
6 properties
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-agreement-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum agreementSpecification API
AE Profile APIs.io
TM Forum billFormat API
AE Profile APIs.io
TM Forum billingAccount API
AE Profile APIs.io
TM Forum billingCycleSpecification API
AE Profile APIs.io
TM Forum billPresentationMedia API
AE Profile APIs.io
TM Forum cancelProductOrder API
AE Profile APIs.io
TM Forum cancelServiceOrder API
AE Profile APIs.io
TM Forum category API
AE Profile APIs.io
TM Forum customer API
AE Profile APIs.io
TM Forum events subscription API
AE Profile APIs.io
TM Forum exportJob API
AE Profile APIs.io
TM Forum financialAccount API
AE Profile APIs.io
#Agreement
← Back to T APIs
API Details
ID
tm-forum:tm-forum-agreement-api
Server
https://serverRoot/tmf-api/agreementManagement/v4/
Docs
https://www.tmforum.org/resources/specification/tmf620-product-catalog-management-api-rest-specification-r17-5-0/
Provider
TM Forum
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=tm-forum-agreement-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/tm-forum-agreement-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of TM Forum agreement API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.