Unlock Your Chance - Grab a 50% Discount on All Plans – Exclusive for the First 100 Lucky Users! JOIN NOW

API Documentation

This is the documentation for the available API endpoints, which are built around the REST architecture. All the API endpoints will return a JSON response with the standard HTTP response codes and need a Bearer Authentication via an API Key.

Authentication

All the API endpoints require an API key sent by the Bearer Authentication method.

curl --request GET \
--url 'https://heo.li/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
All API endpoint results work with the UTC timezone unless specified otherwise.
User
Links
Links statistics
Pixels
Introductory pages
QR Codes
Data
Notification handlers
Custom domains
Payments for account
Account records