v1

latestOpenAPI 3.0.3MIT2026-07-23243157.4 KB

Documents

Returns project documents

post/api/v3/documents

Request body

caseReferencestring required

searchTermstring

Free text search term

pageinteger

Page number

sizeinteger

Page Size (items per page)

datePublishedFromstring date

Filter for documents published on or after {value}

datePublishedTostring date

Filter for documents published on or before {value}

isMaterialChangeboolean

Is project material change

Example request

{
  "caseReference": "TR040009",
  "page": 1,
  "size": 25,
  "filters": [
    {
      "name": "stage",
      "value": 1,
      "type": [
        {
          "value": "Plans"
        }
      ]
    }
  ],
  "datePublishedFrom": "2000-01-01",
  "datePublishedTo": "2023-12-31"
}

Response

Returns list of documents

totalItemsnumber

itemsPerPagenumber

totalPagesnumber

currentPagenumber

Example response

{
  "documents": [
    {
      "id": 12601,
      "dataId": "TR040009-000004",
      "caseReference": "TR040009",
      "stage": 1,
      "type": "Transboundary",
      "filter1": "Environmental Impact Assessment",
      "size": 50427,
      "mime": "application/pdf",
      "publishedDocumentURI": "https://example.com/published/myDoc.pdf",
      "path": "TR040009/TR040009-000004-Regulation 24 Transboundary Screening document.pdf",
      "status": "Published",
      "datePublished": "2015-06-10",
      "lastModified": "2016-04-28 08:42:58",
      "dateCreated": "2016-04-28 08:42:58"
    }
  ],
  "totalItems": 3,
  "itemsPerPage": 20,
  "totalPages": 1,
  "currentPage": 1,
  "filters": [
    {
      "name": "stage",
      "label": "Pre-application",
      "count": 5,
      "type": [
        {
          "value": "Plans",
          "count": 5
        }
      ]
    }
  ]
}