API Documentation

Introduction

The Broker Portal API is versioned, resource-oriented, and uses JSON. Every operation requires valid authentication, the correct granular scope, an allowed data scope, and a valid security policy.

Example request

curl -X GET "https://your-domain.example/api/v1/leads?page=1&limit=50&status=new" \
  -H "Authorization: Bearer bp_live_••••••••" \
  -H "Accept: application/json"

Standard response

{
  "success": true,
  "data": [
    {
      "id": "lea_1",
      "name": "Ahmed",
      "status": "new"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 100,
    "requestId": "req_4a12"
  }
}

External system principle

Odoo, CRM, mobile apps, ERP, websites, and analytics tools can perform the same core operations as the platform UI only when all four controls pass: authentication, API scope, data scope, and security policy.