List Agreements

List items in the Agreements collection.

get

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.platform.softwareone.com/public/v1/commerce/agreements'

200

200

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "href": "text",
      "icon": "text",
      "status": "New",
      "listing": "[Circular Reference]",
      "authorization": "[Circular Reference]",
      "vendor": "[Circular Reference]",
      "client": "[Circular Reference]",
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "SPxY": 1,
        "SPxM": 1,
        "PPxY": 1,
        "PPxM": 1
      },
      "startDate": "2025-04-01T21:58:03.988Z",
      "endDate": "2025-04-01T21:58:03.988Z",
      "template": "[Circular Reference]",
      "error": {
        "id": "text",
        "message": "text",
        "parameters": null
      },
      "name": "text",
      "lines": "[Circular Reference]",
      "subscriptions": "[Circular Reference]",
      "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": "[Circular Reference]",
      "buyer": "[Circular Reference]",
      "seller": "[Circular Reference]",
      "product": "[Circular Reference]",
      "externalIds": {
        "client": "text",
        "operations": "text",
        "vendor": "text"
      },
      "split": "[Circular Reference]",
      "termsAndConditions": "[Circular Reference]"
    }
  ]
}

OK