API-Dokumentation

Hier findest du die Doku zu den verfügbaren API-Endpunkten, basierend auf der REST-Architektur. Alle Endpunkte liefern eine JSON-Response mit den üblichen HTTP-Statuscodes und benötigen eine Bearer-Authentifizierung mit einem API-Key.

 
Get your own API Key

Authentifizierung

Alle API-Endpunkte benötigen einen API-Key, der per Bearer-Authentifizierung gesendet wird.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://paths.to/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": "Du hast keinen Zugriff auf die 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
Alle API-Ergebnisse nutzen die UTC Zeitzone, sofern nicht anders angegeben.
User
Links
Link-Statistiken
Projekte
Pixel
Splash-Seiten
QR-Codes
Signaturen
Daten
Notification-Handler
Eigene Domains
Teams
Team-Mitglieder
Teams-Mitglied
Zahlungen
Account-Logs