Partner API

A read-only REST API to pull your own funnel, leads, conversions and earnings into your systems (CAPI, trackers, dashboards).

Base URL

https://<your-host>/api/v1

All endpoints are versioned under /api/v1 and return JSON. Only GET is supported (plus one POST for login links).

Authentication

Authenticate with your API key as a bearer token. One key is issued automatically with your account; view, copy, or rotate it under API in the portal.

Authorization: Bearer wk_live_xxxxxxxxxxxxxxxxxxxx

warning

Keys are secret. We store only a hash for verification, so a leaked key can't be recovered — rotate it. Rotation revokes the old key immediately. The API is server-to-server: never expose your key in a browser or mobile client.

Response envelope

Every response is one of:

Success

{ "ok": true, "data": { /* endpoint payload */ } }

Error

{ "ok": false, "error": { "code": "unauthorized", "message": "Invalid or revoked API key." } }

Errors

HTTP	code	Meaning
401	unauthorized	Missing, invalid, or revoked key.
404	not_found	Resource doesn't exist or isn't yours.
429	rate_limited	Rate limit hit — see Retry-After header.
500	internal	Unexpected server error.

Rate limits

• 120 requests / minute per key (plus a per-IP ceiling).
• On 429 we send a Retry-After header (seconds). Back off and retry.

Pagination

List endpoints use opaque cursor pagination. Pass the returned cursor to get the next page.

• /conversions is an ascending forward stream — ideal for polling "everything since last time". Keep the last nextCursor and pass it back next poll.
• /leads is newest-first.
• A null nextCursor means you've reached the end of the current window.

Query limits

Param	Default	Constraint
from / to	last 30 days	ISO-8601; max span 92 days (clamped).
limit	100	max 500 (clamped).

What's exposed (and what isn't)

• Everything is scoped to your domains only — you never see another partner's data.
• Conversion / lead data includes attribution and match signals (ip, user_agent, fbp, fbc, fbclid) and deposit values — enough to power Meta CAPI server events.
• Platform-side margin (gross/net gaming revenue, withdrawals) is never exposed. Money fields are your acquisition values and your earnings.

tip

See the Endpoint reference for every route with parameters and example responses.