Partner API — bRRAIn Docs

Programmatic API for partners.brrain.io — leads, deals, billing, cascade rewards.

Partner API

The Partner API exposes the partner portal — lead management, deal tracking, cascade rewards (bOSS), and billing — for programmatic integration.

Base path

https://partners.brrain.io/api

Authenticated as an active partner.

Leads

List leads

GET /leads?stage=&since=&owner=&limit=&cursor=

Stages: new, contacted, qualified, proposal, negotiation, won, lost.

Get a lead

GET /leads/{id}

Full lead detail with action timeline.

Create a lead

POST /leads
Content-Type: application/json

{
  "company_name": "...",
  "contact_email": "...",
  "contact_name": "...",
  "source": "...",
  "notes": "..."
}

Update a lead

PUT /leads/{id}

Update stage, owner, custom fields, etc.

Lead actions timeline

GET /leads/{id}/actions

Returns the chronological timeline — page views, form submits, downloads, communications, stage changes.

Deals

List deals

GET /deals?stage=&since=

Convert a lead to a deal

POST /leads/{id}/convert
Content-Type: application/json

{
  "deal_value": 12000,
  "currency": "USD",
  "expected_close": "2026-08-15"
}

Billing routing

Configure a customer's billing route

POST /billing-routes
Content-Type: application/json

{
  "customer_org_id": "org_...",
  "route_via": "partner",
  "markup_percent": 15
}

route_via:

  • direct — bRRAIn bills the customer directly; partner gets a referral fee.
  • partner — partner bills the customer; partner pays bRRAIn at wholesale rate.

List your billing arrangements

GET /billing-routes

Cascade rewards (bOSS)

bOSS — Business Outcome Sharing System — pays partners when their introduced customer's outcomes meet defined milestones.

List eligible cascades

GET /boss/cascades

Returns cascades you're eligible for, with current outcome state.

Acknowledge a cascade payout

POST /boss/cascades/{id}/acknowledge

Acknowledges receipt of the payout (so we can confirm with finance).

OEM

For OEM partners.

Get OEM agreement state

GET /oem/agreement

Active OEM tier, volume commitments, current usage.

Upload OEM customer record

POST /oem/customers
Content-Type: application/json

{
  "customer_name": "...",
  "subdomain": "...",
  "tier": "starter",
  "branded": true
}

Provisions a customer org under your OEM agreement.

Reporting

GET /reports/revenue?from=&to=
GET /reports/leads?from=&to=
GET /reports/cascades?from=&to=

CSV export with ?format=csv.

Webhooks

  • partner.lead_created
  • partner.lead_stage_changed
  • partner.deal_won
  • partner.deal_lost
  • partner.cascade_triggered
  • partner.payout_issued

Errors

  • partner_not_active — your partner subscription has lapsed.
  • customer_not_under_partner — operation requires an org you've introduced or that's billed via your route.
  • cascade_already_acknowledged
  • oem_quota_exceeded

Where to next