GET/v1/definitions/{key}/rows/{rowId}/contract/documents

List a deal's contract documents

The papers issued on one deal — rendered documents, each with the template version it was built from — newest first. The path says contract in the singular and carries no contract id because the DEAL ROW is the contract's address in this service. Deals page only.

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": [
    {
      "body": "string",
      "bodyFormat": "string",
      "id": "",
      "kind": "string",
      "renderedAt": "string",
      "renderedBy": 1,
      "rowId": "",
      "substitutions": {},
      "templateId": "",
      "templateVersion": 1,
      "title": "string"
    }
  ]
}

dataarray<>optional

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