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://birbshare.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
User
Files
Transfers
Transfer statistics
Transfer downloads statistics
Projects
Pixels
Custom domains
Notification handlers
Payments
Logs