Skip to content

API reference

Base URL /api/v1. All requests use a secret key: Authorization: Bearer sk_test_…

POST /api/v1/leads

Record a customer's yes for an offer. Body: offer_id, email, disclosure_text, optional contact and surface. Duplicates return status duplicate and are not charged.

GET /api/v1/leads

List the latest 100 leads for your account. Contact details are delivered by webhook, not listed here.

Webhook endpoints, events, refund requests

GET and POST /api/v1/webhook_endpoints, GET /api/v1/events, POST /api/v1/refund_requests.

Idempotency

Keys are kept for 24 hours. Reusing a key with a different body returns 422. A key still in progress returns 409.

Errors

Errors return { error: { type, code, message, param, doc_url } } with a matching HTTP status.