API reference
The RentalTide API lets you programmatically manage bookings, inventory, customers, transactions, and more. Every action available in the dashboard is available through the API.
Base URL
All API requests are made to:
Authentication
The API supports two authentication methods.
Bearer token (JWT)
Include your JWT in the Authorization header. Tokens are issued through Auth0 when a user logs in to the dashboard.
API key
For server-to-server integrations, use a static API key. Generate one from Admin > API Keys in the dashboard.
API keys carry the same permissions as the user who created them. Never expose them in client-side code or public repositories.
Request format
All request bodies must be JSON with the Content-Type: application/json header.
Response format
Every response returns JSON. Successful responses use this structure:
Error responses include a message and an error code:
HTTP status codes
| Code | Meaning |
|---|---|
200 | Success |
201 | Created |
400 | Bad request — check the request body |
401 | Unauthorized — missing or invalid credentials |
403 | Forbidden — valid credentials but insufficient permissions |
404 | Not found |
409 | Conflict — resource state prevents the action |
429 | Rate limited — slow down |
500 | Internal server error |
Rate limits
API requests are rate-limited per authentication credential:
| Plan | Limit |
|---|---|
| Standard | 100 requests per minute |
| Enterprise | 500 requests per minute |
When you exceed the limit, the API returns a 429 status with a Retry-After header indicating how many seconds to wait.
Webhook deliveries and dashboard usage do not count against your API rate limit.
Pagination
List endpoints return paginated results. Use the limit and offset query parameters to navigate pages.
The response includes a total count:
API sections
Webhooks
RentalTide can send real-time event notifications to your server. Configure webhook endpoints from Admin > Webhooks in the dashboard.
Supported events
| Event | Fired when |
|---|---|
booking.created | A new booking is placed |
booking.updated | A booking is modified |
booking.cancelled | A booking is cancelled |
booking.checked_in | A customer checks in |
booking.checked_out | A rental is returned |
payment.completed | A payment is captured |
payment.refunded | A refund is issued |
customer.created | A new customer record is created |
Webhook payload
Each webhook request includes an X-RentalTide-Signature header. Verify this HMAC-SHA256 signature against your webhook secret to confirm the request came from RentalTide.