Rinkel API
For access, documentation and other information, please visit https://developers.rinkel.com.
Authenticate every request by sending your API key as a Bearer token:
Authorization: Bearer <your-api-key>. The x-rinkel-api-key header is
legacy: it keeps working, but new integrations should use Authorization.
Any endpoint may respond with 403 Forbidden and error code FREEMIUM_ACCOUNT_INACTIVE
(body { "errors": [{ "code": "FREEMIUM_ACCOUNT_INACTIVE" }] }) when the account is on a
freemium plan and has been suspended for inactivity. Upgrading to a paid plan reactivates
the account.
Authentication
- HTTP: Bearer Auth
- API Key: apiKeyAuth
Send your API key as a Bearer token in the Authorization header:
Authorization: Bearer <your-api-key>
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Legacy. Send your API key in the x-rinkel-api-key header. This header
is still supported, but new integrations should use the Authorization: Bearer
header instead. When both headers are sent, Authorization is used.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | x-rinkel-api-key |