Get a relation (scope relations:read)

GET/api/v1/relations/{id}

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

idstringrequired

Responses

200

Single resource

idstringrequired

kindstringrequired

systemKindstring | nullrequired

systemCodestring | nullrequired

companyNamestring | nullrequired

firstNamestring | nullrequired

lastNamestring | nullrequired

emailstring | nullrequired

phonestring | nullrequired

departmentIdstring | nullrequired

accessLevelIdstring | nullrequired

activebooleanrequired

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/relations/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("/api/v1/relations/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/relations/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "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"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}