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

List relations (scope relations:read)

GET/api/v1/relations
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
Responses
200

Paginated list

itemsobject[]required
Show properties
Array of object
idstringrequired
kindstringrequired
systemKindstring | nullrequired
systemCodestring | nullrequired
companyNamestring | nullrequired
firstNamestring | nullrequired
lastNamestring | nullrequired
emailstring | nullrequired
phonestring | nullrequired
departmentIdstring | nullrequired
accessLevelIdstring | nullrequired
activebooleanrequired
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/relations' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "items": [
    {
      "id": "string",
      "kind": "string",
      "systemKind": "string",
      "systemCode": "string",
      "companyName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "departmentId": "string",
      "accessLevelId": "string",
      "active": true,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "total": 0,
  "skip": 0,
  "top": 0
}