Nodes API
The Nodes API allows you to manage the hierarchical node structure in the Apex Brokerage platform.
Base Path
/api/v1/integration/nodes
Overview
Nodes represent a hierarchical tree structure in the Apex Brokerage platform. Each node can have:
- A parent node (except root nodes)
- Child nodes
- A type (Apex, Account, or SubAccount)
- A unique path in the tree structure
Node Types
| Type | Value | Description |
|---|---|---|
| Apex | 1 | Apex node type |
| Account | 2 | Account node type |
| SubAccount | 3 | SubAccount node type |
Authentication
All endpoints require authentication using a Bearer token in the Authorization header.
Required Headers:
Authorization: Bearer <access_token>
X-Target-Server: integration
Available Operations
- Create Node - Create a new node in the tree structure
- Get Node - Retrieve a specific node by its ID
- Update Node - Update an existing node
- Delete Node - Delete a node (soft delete)
- Get Node Children - Get direct children of a node with pagination