Buyer API Reference
This reference documents buyer-facing API endpoints available to approved buyers.
Some beta endpoints require feature enablement for your account.
Authentication endpoints
Method | Path | Purpose |
|---|---|---|
POST | /api/v1/auth/buyer | Exchange buyer API key for a bearer token. |
POST | /api/v1/auth/buyer/email | Portal-style email/password login for provisioned users. |
Lead and delivery endpoints
Method | Path | Purpose |
|---|---|---|
GET | /api/v1/buyer/leads | Paginated delivery list with linked lead fields. Supports page, pageSize, status, from, and to. |
GET | /api/v1/buyer/leads/:deliveryId | Single delivery detail. |
GET | /api/v1/buyer/export | CSV export of delivered leads, including TCPA/source fields. |
GET | /api/v1/buyer/stats?days=30 | Delivery, revenue, status, pacing, and offer stats. |
GET | /api/v1/buyer/analytics?days=30 | Beta analytics by source/campaign. Requires account enablement. |
Controls and account endpoints
Method | Path | Purpose |
|---|---|---|
PATCH | /api/v1/buyer/caps | Lower offer caps. Cap increases require admin approval. |
PATCH | /api/v1/buyer/pause | Pause or resume one or all owned offers. |
GET | /api/v1/buyer/billing | Read-only invoices, balance, and ledger. |
GET | /api/v1/buyer/account | Account/contact/delivery settings. |
PATCH | /api/v1/buyer/account | Edit whitelisted account fields. |
Quality endpoints
Method | Path | Purpose |
|---|---|---|
GET | /api/v1/buyer/return-policy | Return window, caps, allowed reason codes, and proof requirements. |
POST | /api/v1/buyer/returns | Submit an objective lead or booking return. |
GET | /api/v1/buyer/returns/history | Return history for the authenticated partner. |
POST | /api/v1/buyer/disputes | File a dispute with optional detail/evidence URL. |
GET | /api/v1/buyer/disputes/history | Dispute history for the authenticated partner. |