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

List document metadata (scope documents:read)

GET/api/v1/documents
Authorization
AuthorizationBearer token · headerrequired

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

Query parameters
$topinteger

Page size ($top, max 200).

min 1 · max 200
$skipinteger

Offset ($skip).

min 0
relationIdstring
min length 1
Responses
200

Paginated list

itemsobject[]required
Show properties
Array of object
idstringrequired
matterIdstring | nullrequired
relationIdstring | nullrequired
typestringrequired
subjectstring | nullrequired
correspondenceNumberstring | nullrequired
contentTypestring | nullrequired
sizeBytesinteger | nullrequired
latestChecksumstring | nullrequired
departmentIdstring | nullrequired
accessLevelIdstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
totalintegerrequired
skipintegerrequired
topintegerrequired
401

Unauthenticated

errorstringrequired
codestringrequired
rulestring
403

Forbidden (missing scope or permission)

errorstringrequired
codestringrequired
rulestring
429

Rate limited

errorstringrequired
codestringrequired
rulestring
Request
curl -X GET '/api/v1/documents' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "items": [
    {
      "id": "string",
      "matterId": "string",
      "relationId": "string",
      "type": "string",
      "subject": "string",
      "correspondenceNumber": "string",
      "contentType": "string",
      "sizeBytes": 0,
      "latestChecksum": "string",
      "departmentId": "string",
      "accessLevelId": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "total": 0,
  "skip": 0,
  "top": 0
}