List Agreements

List items in the Agreements collection.

get

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /public/v1/commerce/agreements HTTP/1.1
Host: api.platform.softwareone.com
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"
        ]
      },
      "icon": "text",
      "status": "New",
      "listing": {
        "id": "text"
      },
      "authorization": {
        "id": "text",
        "name": "text",
        "currency": "text"
      },
      "vendor": {
        "id": "text",
        "icon": "text",
        "type": "Client",
        "status": "Active",
        "name": "text"
      },
      "client": {
        "id": "text",
        "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-07-06T13:38:59.435Z",
      "endDate": "2025-07-06T13:38:59.435Z",
      "template": {
        "id": "text",
        "name": "text"
      },
      "error": {
        "id": "text",
        "message": "text",
        "parameters": null
      },
      "name": "text",
      "lines": [
        {
          "id": "text",
          "quantity": 1,
          "item": "[Circular Reference]",
          "audit": "[Circular Reference]",
          "price": {
            "currency": "text",
            "markup": 1,
            "margin": 1,
            "unitSP": 1,
            "unitPP": 1,
            "PPx1": 1,
            "SPx1": 1
          },
          "order": "[Circular Reference]",
          "status": "Active"
        }
      ],
      "subscriptions": [
        {
          "id": "text",
          "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",
        "icon": "text",
        "name": "text",
        "externalId": "text"
      },
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text",
        "erpLink": "[Circular Reference]"
      },
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "externalIds": {
        "client": "text",
        "operations": "text",
        "vendor": "text"
      },
      "split": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "allocations": [
          "[Circular Reference]"
        ]
      },
      "termsAndConditions": [
        {
          "id": "text",
          "audit": "[Circular Reference]",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "description": "text",
          "displayOrder": 1,
          "status": "text",
          "product": {
            "id": "text",
            "name": "text",
            "externalIds": {
              "operations": "text"
            },
            "icon": "text",
            "status": "text"
          },
          "accepted": "2025-07-06T13:38:59.435Z",
          "acceptedBy": {
            "id": "text",
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "firstName": "text",
            "lastName": "text",
            "email": "text",
            "icon": "text"
          }
        }
      ],
      "certificates": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  ]
}