Skip to content
Basenet
🇳🇱 Nederlands
🇳🇱 Nederlands🇬🇧 English
Esc
↑↓navigate↵open⌘Jpreview

Get a permission-filtered proposal (scope proposals:read)

GET/api/v1/proposals/{id}
Authorization
AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Path parameters
idstringrequired
min length 1
Responses
200

Proposal

proposalobjectrequired
Show properties
idstringrequired
capabilityIdstringrequired
statusstringrequired
Allowed:openacceptedcommittedcancelledexpired
versionintegerrequired
inputobjectrequired
rationalestring | nullrequired
evidenceany
metadataobjectrequired
Show properties
duplicateMatchesobject[]
Show properties
Array of object
idstringrequired
labelstring
reasonstringrequired
Allowed:kvkemailname_birthdaycompany_name
scorenumberrequired
confirmDuplicatesboolean
Allowed:true
riskFlagsstring[] | nullrequired
expiresAtstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
401

Unauthenticated

errorstringrequired
codestringrequired
rulestring
403

Forbidden (missing scope or permission)

errorstringrequired
codestringrequired
rulestring
404

Not found

errorstringrequired
codestringrequired
rulestring
429

Rate limited

errorstringrequired
codestringrequired
rulestring
Request
curl -X GET '/api/v1/proposals/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "proposal": {
    "id": "string",
    "capabilityId": "string",
    "status": "open",
    "version": 1,
    "input": {
      "property1": null,
      "property2": null
    },
    "rationale": "string",
    "evidence": null,
    "metadata": {
      "duplicateMatches": [
        {
          "id": "string",
          "label": "string",
          "reason": "kvk",
          "score": 0
        }
      ],
      "confirmDuplicates": true
    },
    "riskFlags": [
      "string"
    ],
    "expiresAt": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}