List Documents

Lists all documents based on filter criteria.

get

Path parameters

programIdstringRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /public/v1/program/programs/{programId}/documents 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": {
          "at": "2025-09-26T19:53:06.671Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2025-09-26T19:53:06.671Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "revision": 1,
      "type": "text",
      "description": "text",
      "status": "Draft",
      "filename": "text",
      "size": 1,
      "contentType": "text",
      "url": "text",
      "language": "text",
      "program": {
        "id": "text",
        "name": "text",
        "revision": 1,
        "status": "None",
        "applicableTo": "Buyer",
        "products": [
          {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-09-26T19:53:06.671Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2025-09-26T19:53:06.671Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "published": {
                "at": "2025-09-26T19:53:06.671Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "pending": {
                "at": "2025-09-26T19:53:06.671Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "unpublished": {
                "at": "2025-09-26T19:53:06.671Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "icon": "text",
            "revision": 1,
            "shortDescription": "text",
            "longDescription": "text",
            "externalIds": {
              "operations": "text",
              "defaultErpItem": "text"
            },
            "website": "text",
            "status": "text",
            "vendor": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "type": "Client",
              "status": "Active"
            },
            "settings": {
              "productOrdering": true,
              "productRequests": {
                "enabled": true,
                "name": "text",
                "label": "text"
              },
              "itemSelection": true,
              "orderQueueChanges": true,
              "preValidation": {
                "purchaseOrderDraft": true,
                "purchaseOrderQuerying": true,
                "changeOrderDraft": true,
                "configurationOrderDraft": true,
                "terminationOrder": true,
                "productRequest": true
              },
              "splitBilling": {
                "enabled": true,
                "type": "text"
              },
              "sendCostToErp": true,
              "subscriptionCessation": {
                "enabled": true,
                "mode": "Termination"
              }
            },
            "statistics": {
              "itemCount": 1,
              "ordersPlacedCount": 1,
              "agreementCount": 1,
              "subscriptionCount": 1,
              "requestCount": 1
            }
          }
        ]
      }
    }
  ]
}