Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/tm-forum-agreementspecification-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Agreement Management Agreement Specification API
description: This is Swagger UI environment generated for the TMF Agreement Management specification
version: 4.0.0
servers:
- url: https://serverRoot/tmf-api/agreementManagement/v4/
tags:
- name: agreementSpecification
paths:
/agreementSpecification:
get:
operationId: listAgreementSpecification
summary: List or find AgreementSpecification objects
description: This operation list or find AgreementSpecification entities
tags:
- agreementSpecification
parameters:
- name: fields
description: Comma-separated properties to be provided in response
required: false
in: query
schema:
type: string
- name: offset
description: Requested index for start of resources to be provided in response
required: false
in: query
schema:
type: integer
- name: limit
description: Requested number of resources to be provided in response
required: false
in: query
schema:
type: integer
responses:
'200':
description: Success
headers:
X-Result-Count:
description: Actual number of items returned in the response body
schema:
type: integer
X-Total-Count:
description: Total number of items matching criteria
schema:
type: integer
content:
application/json;charset=utf-8:
schema:
type: array
items:
$ref: '#/components/schemas/AgreementSpecification'
'400':
description: Bad Request
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not allowed
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
post:
operationId: createAgreementSpecification
summary: Creates a AgreementSpecification
description: This operation creates a AgreementSpecification entity.
tags:
- agreementSpecification
responses:
'201':
description: Created
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/AgreementSpecification'
'400':
description: Bad Request
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not allowed
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/AgreementSpecification_Create'
description: The AgreementSpecification to be created
required: true
/agreementSpecification/{id}:
get:
operationId: retrieveAgreementSpecification
summary: Retrieves a AgreementSpecification by ID
description: This operation retrieves a AgreementSpecification entity. Attribute selection is enabled for all first level attributes.
tags:
- agreementSpecification
parameters:
- name: id
description: Identifier of the AgreementSpecification
required: true
in: path
schema:
type: string
- name: fields
description: Comma-separated properties to provide in response
required: false
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/AgreementSpecification'
'400':
description: Bad Request
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not allowed
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
patch:
operationId: patchAgreementSpecification
summary: Updates partially a AgreementSpecification
description: This operation updates partially a AgreementSpecification entity.
tags:
- agreementSpecification
parameters:
- name: id
description: Identifier of the AgreementSpecification
required: true
in: path
schema:
type: string
responses:
'200':
description: Updated
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/AgreementSpecification'
'400':
description: Bad Request
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not allowed
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/AgreementSpecification_Update'
description: The AgreementSpecification to be updated
required: true
delete:
operationId: deleteAgreementSpecification
summary: Deletes a AgreementSpecification
description: This operation deletes a AgreementSpecification entity.
tags:
- agreementSpecification
parameters:
- name: id
description: Identifier of the AgreementSpecification
required: true
in: path
schema:
type: string
responses:
'204':
description: Deleted
'400':
description: Bad Request
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not allowed
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Quantity:
type: object
description: An amount in a given unit
properties:
amount:
default: 1
type: number
format: float
description: Numeric value in a given unit
units:
type: string
description: Unit
AgreementSpecCharacteristicValue:
type: object
description: A number or text that can be assigned to an agreement specification characteristic.
properties:
default:
type: boolean
description: Indicates if the value is the default value for a characteristic
unitOfMeasure:
type: string
description: Unit of measure for the characteristic, such as minutes, gigabytes (GB) and so on.
valueFrom:
type: string
description: The low range value that a characteristic can take on
valueTo:
type: string
description: The upper range value that a characteristic can take on
valueType:
type: string
description: A kind of value that the characteristic can take on, such as numeric, text, and so forth
validFor:
$ref: '#/components/schemas/TimePeriod'
description: The period of time for which a value is applicable
value:
$ref: '#/components/schemas/Any'
description: A discrete value that the characteristic can take on
'@baseType':
type: string
description: When sub-classing, this defines the super-class
'@schemaLocation':
type: string
format: uri
description: A URI to a JSON-Schema file that defines additional attributes and relationships
'@type':
type: string
description: When sub-classing, this defines the sub-class entity name
AgreementSpecification_Create:
type: object
description: 'A template of an agreement that can be used when establishing partnerships
Skipped properties: id,href'
required:
- attachment
- name
properties:
description:
type: string
description: A narrative that explains in detail what the agreement specification is about
isBundle:
type: boolean
description: If true, this agreement specification is a grouping of other agreement specifications. The list of bundled agreement specifications is provided by the specificationRelationship property
lastUpdate:
type: string
format: date-time
description: Date and time of the last update
lifecycleStatus:
type: string
description: Indicates the current lifecycle status
name:
type: string
description: Name of the agreement specification
version:
type: string
description: Agreement specification version
attachment:
type: array
items:
$ref: '#/components/schemas/AttachmentRefOrValue'
minItems: 1
relatedParty:
type: array
items:
$ref: '#/components/schemas/RelatedParty'
serviceCategory:
$ref: '#/components/schemas/CategoryRef'
specificationCharacteristic:
type: array
items:
$ref: '#/components/schemas/AgreementSpecCharacteristic'
specificationRelationship:
type: array
items:
$ref: '#/components/schemas/AgreementSpecificationRelationship'
validFor:
$ref: '#/components/schemas/TimePeriod'
description: The period for which the agreement specification is valid
'@baseType':
type: string
description: When sub-classing, this defines the super-class
'@schemaLocation':
type: string
format: uri
description: A URI to a JSON-Schema file that defines additional attributes and relationships
'@type':
type: string
description: When sub-classing, this defines the sub-class entity name
AgreementSpecification_Update:
type: object
description: 'A template of an agreement that can be used when establishing partnerships
Skipped properties: id,href'
required:
- attachment
- name
properties:
description:
type: string
description: A narrative that explains in detail what the agreement specification is about
isBundle:
type: boolean
description: If true, this agreement specification is a grouping of other agreement specifications. The list of bundled agreement specifications is provided by the specificationRelationship property
lastUpdate:
type: string
format: date-time
description: Date and time of the last update
lifecycleStatus:
type: string
description: Indicates the current lifecycle status
name:
type: string
description: Name of the agreement specification
version:
type: string
description: Agreement specification version
attachment:
type: array
items:
$ref: '#/components/schemas/AttachmentRefOrValue'
minItems: 1
relatedParty:
type: array
items:
$ref: '#/components/schemas/RelatedParty'
serviceCategory:
$ref: '#/components/schemas/CategoryRef'
specificationCharacteristic:
type: array
items:
$ref: '#/components/schemas/AgreementSpecCharacteristic'
specificationRelationship:
type: array
items:
$ref: '#/components/schemas/AgreementSpecificationRelationship'
validFor:
$ref: '#/components/schemas/TimePeriod'
description: The period for which the agreement specification is valid
'@baseType':
type: string
description: When sub-classing, this defines the super-class
'@schemaLocation':
type: string
format: uri
description: A URI to a JSON-Schema file that defines additional attributes and relationships
'@type':
type: string
description: When sub-classing, this defines the sub-class entity name
Error:
description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
type: object
required:
- code
- reason
properties:
code:
type: string
description: Application relevant detail, defined in the API or a common list.
reason:
type: string
description: Explanation of the reason for the error which can be shown to a client user.
message:
type: string
description: More details and corrective actions related to the error which can be shown to a client user.
status:
type: string
description: HTTP Error code extension
referenceError:
type: string
format: uri
description: URI of documentation describing the error.
'@baseType':
type: string
description: When sub-classing, this defines the super-class.
'@schemaLocation':
type: string
format: uri
description: A URI to a JSON-Schema file that defines additional attributes and relationships
'@type':
type: string
description: When sub-classing, this defines the sub-class entity name.
Any: {}
AttachmentRefOrValue:
type: object
description: An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture.
properties:
id:
type: string
description: Unique identifier for this particular attachment
href:
type: string
description: URI for this Attachment
attachmentType:
type: string
description: Attachment type such as video, picture
content:
type: string
description: The actual contents of the attachment object, if embedded, encoded as base64
description:
type: string
description: A narrative text describing the content of the attachment
mimeType:
type: string
description: Attachment mime type such as extension file for video, picture and document
name:
type: string
description: The name of the attachment
url:
type: string
description: Uniform Resource Locator, is a web page address (a subset of URI)
size:
$ref: '#/components/schemas/Quantity'
description: The size of the attachment.
validFor:
$ref: '#/components/schemas/TimePeriod'
description: The period of time for which the attachment is valid
'@baseType':
type: string
description: When sub-classing, this defines the super-class
'@schemaLocation':
type: string
format: uri
description: A URI to a JSON-Schema file that defines additional attributes and relationships
'@type':
type: string
description: When sub-classing, this defines the sub-class entity name
'@referredType':
type: string
description: The actual type of the target instance when needed for disambiguation.
AgreementSpecificationRelationship:
type: object
description: A relationship between agreement specifications. Typical relationships are substitution and dependency.
properties:
id:
type: string
description: Unique identifier of a related entity.
href:
type: string
description: Reference of the related entity.
name:
type: string
description: Name of the related entity.
relationshipType:
type: string
description: Type of relationship such as, substitution or dependency.
validFor:
$ref: '#/components/schemas/TimePeriod'
description: The period for which the relationship is valid
'@baseType':
type: string
description: When sub-classing, this defines the super-class
'@schemaLocation':
type: string
format: uri
description: A URI to a JSON-Schema file that defines additional attributes and relationships
'@type':
type: string
description: When sub-classing, this defines the sub-class entity name
'@referredType':
type: string
description: The actual type of the target instance when needed for disambiguation.
CategoryRef:
type: object
description: The category for grouping recommendations
properties:
id:
type: string
description: Unique identifier of a related entity.
href:
type: string
description: Reference of the related entity.
name:
type: string
description: Name of the related entity.
version:
type: string
description: Category version
'@baseType':
type: string
description: When sub-classing, this defines the super-class
'@schemaLocation':
type: string
format: uri
description: A URI to a JSON-Schema file that defines additional attributes and relationships
'@type':
type: string
description: When sub-classing, this defines the sub-class entity name
'@referredType':
type: string
description: The actual type of the target instance when needed for disambiguation.
required:
- id
TimePeriod:
type: object
description: A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
properties:
endDateTime:
type: string
format: date-time
description: End of the time period, using IETC-RFC-3339 format
startDateTime:
type: string
format: date-time
description: Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end
AgreementSpecCharacteristic:
type: object
description: A characteristic quality or distinctive feature of an agreement.
properties:
configurable:
type: boolean
description: If true, the Boolean indicates that the characteristic is configurable
description:
type: string
description: A narrative that explains in detail what the characteristic is
name:
type: string
description: Name of the characteristic being specified.
valueType:
type: string
description: A kind of value that the characteristic can take on, such as numeric, text and so forth
specCharacteristicValue:
type: array
items:
$ref: '#/components/schemas/AgreementSpecCharacteristicValue'
validFor:
$ref: '#/components/schemas/TimePeriod'
description: The period for which the specification characteristic is valid
'@baseType':
type: string
description: When sub-classing, this defines the super-class
'@schemaLocation':
type: string
format: uri
description: A URI to a JSON-Schema file that defines additional attributes and relationships
'@type':
type: string
description: When sub-classing, this defines the sub-class entity name
AgreementSpecification:
type: object
description: A template of an agreement that can be used when establishing partnerships
required:
- attachment
- name
properties:
id:
type: string
description: Unique identifier of the agreement specification
href:
type: string
description: Reference of the agreement specification
description:
type: string
description: A narrative that explains in detail what the agreement specification is about
isBundle:
type: boolean
description: If true, this agreement specification is a grouping of other agreement specifications. The list of bundled agreement specifications is provided by the specificationRelationship property
lastUpdate:
type: string
format: date-time
description: Date and time of the last update
lifecycleStatus:
type: string
description: Indicates the current lifecycle status
name:
type: string
description: Name of the agreement specification
version:
type: string
description: Agreement specification version
attachment:
type: array
items:
$ref: '#/components/schemas/AttachmentRefOrValue'
minItems: 1
relatedParty:
type: array
items:
$ref: '#/components/schemas/RelatedParty'
serviceCategory:
$ref: '#/components/schemas/CategoryRef'
specificationCharacteristic:
type: array
items:
$ref: '#/components/schemas/AgreementSpecCharacteristic'
specificationRelationship:
type: array
items:
$ref: '#/components/schemas/AgreementSpecificationRelationship'
validFor:
$ref: '#/components/schemas/TimePeriod'
description: The period for which the agreement specification is valid
'@baseType':
type: string
description: When sub-classing, this defines the super-class
'@schemaLocation':
type: string
format: uri
description: A URI to a JSON-Schema file that defines additional attributes and relationships
'@type':
type: string
description: When sub-classing, this defines the sub-class entity name
RelatedParty:
type: object
description: Related Entity reference. A related party defines party or party role linked to a specific entity.
required:
- '@referredType'
- id
- name
properties:
id:
type: string
description: Unique identifier of a related entity.
href:
type: string
description: Reference of the related entity.
name:
type: string
description: Name of the related entity.
role:
type: string
description: Role played by the related party
'@baseType':
type: string
description: When sub-classing, this defines the super-class
'@schemaLocation':
type: string
format: uri
description: A URI to a JSON-Schema file that defines additional attributes and relationships
'@type':
type: string
description: When sub-classing, this defines the sub-class entity name
'@referredType':
type: string
description: The actual type of the target instance when needed for disambiguation.