GET/v1/workspace/underwriting-criteria

Read the workspace's underwriting criteria

The workspace's underwriting scorecard TEMPLATE: the questions this lender asks of every deal, each with its label, category, value kind, threshold and comparison. The ANSWERS live on a record and are served from the deal, not here. Any seat, because the tab has to draw the checklist.

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

Responses

200application/json

the action's answer

{
  "data": [
    {
      "active": true,
      "autoSource": "string",
      "category": "string",
      "comparison": "string",
      "createdAt": "string",
      "id": 1.5,
      "key": "string",
      "label": "string",
      "sortOrder": 1.5,
      "threshold": 1.5,
      "updatedAt": "string",
      "valueKind": "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