GET/v1/definitions/{key}/rows/{rowId}/document-requests

List the documents requested from a record

What is still owed on one record: every document asked for, open ones first and oldest ask first inside each group, with the period each covers. This is what the desk has ASKED for; get_definitions_key_rows_rowId_documents_checklist is the wider question of what the record's form asked for and what has actually arrived.

Access class: def:read.

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.

keypath · stringrequired

rowIdpath · stringrequired

bodyquery · nulloptional

paramsquery · objectoptional

:keystringoptional

:rowIdstringoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": [
    {
      "documentType": "string",
      "fulfilledAt": "string",
      "fulfilledBy": 1.5,
      "fulfilledFileId": "",
      "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