List Agreements
List items in the Agreements collection.
get
Responses
200
OK
application/json
get
GET /public/v1/commerce/agreements HTTP/1.1
Host: api.s1.today
Accept: */*
200
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"active": "[Circular Reference]",
"provisioning": "[Circular Reference]",
"terminated": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"icon": "text",
"status": "New",
"listing": {
"id": "text",
"revision": 1
},
"authorization": {
"id": "text",
"revision": 1,
"name": "text",
"currency": "text"
},
"vendor": {
"id": "text",
"revision": 1,
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"client": {
"id": "text",
"revision": 1,
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"startDate": "2025-09-05T20:33:52.998Z",
"endDate": "2025-09-05T20:33:52.998Z",
"template": {
"id": "text",
"revision": 1,
"name": "text"
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"name": "text",
"lines": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"quantity": 1,
"item": "[Circular Reference]",
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"unitSP": 1,
"unitPP": 1,
"PPx1": 1,
"SPx1": 1,
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"order": "[Circular Reference]",
"status": "Active",
"subscription": "[Circular Reference]",
"asset": "[Circular Reference]",
"agreement": "[Circular Reference]",
"client": "[Circular Reference]",
"vendor": "[Circular Reference]",
"buyer": "[Circular Reference]",
"seller": "[Circular Reference]",
"product": "[Circular Reference]"
}
],
"assets": [
{
"id": "text",
"revision": 1,
"name": "text",
"status": "New"
}
],
"subscriptions": [
{
"id": "text",
"revision": 1,
"name": "text"
}
],
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Configuration",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Configuration",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"licensee": {
"id": "text",
"revision": 1,
"icon": "text",
"name": "text",
"externalId": "text"
},
"buyer": {
"id": "text",
"revision": 1,
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"revision": 1,
"icon": "text",
"externalId": "text",
"name": "text"
},
"product": {
"id": "text",
"revision": 1,
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"split": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"allocations": [
"[Circular Reference]"
]
},
"termsAndConditions": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"product": {
"id": "text",
"revision": 1,
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"accepted": "2025-09-05T20:33:52.998Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
],
"certificates": [
{
"id": "text",
"revision": 1,
"name": "text"
}
]
}
]
}Last updated
Was this helpful?