Install our app 🪄 Click on the icon in the top right of the address bar.

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://www.your.bzh/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
User
Links
Links statistics
Projects
Pixels
Splash pages
QR codes
Signatures
Data
Custom domains
Teams
Team members
Teams member
Payments
Logs