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.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://flinxy.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://flinxy.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
Errors
Our API uses conventional HTTP status codes to indicate the success or failure of a request.
{
"errors": [
{
"title": "You do not have access to the API.",
"status": 401
}
]
}
200 Request completed successfully
400 Bad request - Required parameters are missing or invalid
401 Unauthorized - API key is missing or invalid
404 The requested resource was not found
429 Too many requests - Rate limit exceeded
500 Internal server error - this means there is a problem on our end
All API endpoint results work with the UTC timezone unless specified otherwise.
User
Links
Links statistics
Pixels
Splash pages
QR codes
Data
Notification handlers
Custom domains
Teams
Team members
Teams' member
Account payments
Account logs