GET/v1/document-requests

List outstanding document requests

Everything the workspace is still WAITING ON — every open document request, across every page, oldest ask first. The read for "what paperwork are we still chasing", "what stips are outstanding", "what have we not had back yet". ?limit= caps it. Only OPEN asks are here: a request leaves this list when post_document-requests_id_fulfil pins the file that arrived or post_document-requests_id_cancel withdraws it. For one record's asks read get_definitions_key_rows_rowId_document-requests instead.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

bodyquery · nulloptional

paramsquery · objectoptional

queryquery · objectoptional

limitintegeroptional

Responses

200application/json

the action's answer

{
  "data": [
    {
      "documentType": "string",
      "id": "",
      "note": "string",
      "periods": [
        {
          "label": "string",
          "periodEnd": "string",
          "periodStart": "string"
        }
      ],
      "requestedAt": "string",
      "requestedBy": 1.5,
      "rowId": "",
      "status": "string"
    }
  ]
}

dataarray<>required

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired