Base URL
Quick example
What you can do
Read analytics
Channels, Links,
Clicks and
Visitor journeys.
Drive referrals
Enroll referrers and report signups for product-led referral
programmes.
Manage credit rewards
React to events
Subscribe to signed webhooks for clicks, leads, sales and commissions.
Before you start
The API is a paid-plan feature. Every
/api/v1 endpoint requires the workspace to be on an
active paid plan; free workspaces receive a 402. Generate keys under Settings → Developers.1
Create an API key
See Authentication.
2
Make an authenticated request
Send your key as a Bearer token.
3
Handle errors and paginate
See Errors and
Rate limits & pagination.

