---
search:
  tags:
    - relations
    - GET
seo:
  description: >-
    List relations (scope relations:read). Reference for the GET
    /api/v1/relations endpoint in the Basenet Public API.
sidebar:
  label: List relations (scope relations:read)
  badge: GET
title: List relations (scope relations:read)
type: openapi-operation
---
Endpoint: `GET /api/v1/relations`

Authentication: `bearerAuth` (Scoped API token (bnx\_…). Required scopes are noted per operation.)

Parameters:
- `$top` (in query, integer, optional): Page size ($top, max 200).
- `$skip` (in query, integer or null, optional): Offset ($skip).

Responses:
- `200`: Paginated list
- `401`: Unauthenticated
- `403`: Forbidden (missing scope or permission)
- `429`: Rate limited

Response 200 body (`application/json`):
- `items` (array of object, required)
- `items[].id` (string, required)
- `items[].kind` (string, required)
- `items[].systemKind` (string or null, required)
- `items[].systemCode` (string or null, required)
- `items[].companyName` (string or null, required)
- `items[].firstName` (string or null, required)
- `items[].lastName` (string or null, required)
- `items[].email` (string or null, required)
- `items[].phone` (string or null, required)
- `items[].departmentId` (string or null, required)
- `items[].accessLevelId` (string or null, required)
- `items[].active` (boolean, required)
- `items[].createdAt` (string, required)
- `items[].updatedAt` (string, required)
- `total` (integer, required)
- `skip` (integer, required)
- `top` (integer, required)