// The API

Boring, in a good way.

Predictable JSON. Conventional verbs. Real HTTP status codes. Authenticate with one header and point your backend at our endpoint.

  • X-API-Key auth — rotatable per environment
  • Idempotent writes with request keys
  • Webhooks for every state transition
  • OpenAPI spec + Postman collection
Get your API key →
terminal — referrio
$ curl -X POST https://api.referrio.co.uk/v1/users \
  -H "X-API-Key: rk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "cust_123",
    "email": "jane@example.com",
    "name": "Jane Doe"
  }'

→ 201 Created
  {
    "referral_code": "JANE-A1B2C3",
    "share_url": "https://yourshop.com/?r=JANE-A1B2C3"
  }
POST /v1/users

Create a referrer and mint a code.

POST /v1/referrals

Track a sale against a code.

GET /v1/rewards

List issued rewards & payout status.

POST /v1/campaigns

Define eligibility & reward rules.

POST /v1/vouchers

Upload voucher pools.

GET /v1/track/{code}

Count a click on a referral link.