API Documentation
RESTful API for Tours & Events Management
A RESTful API for managing tours, events, guests, vehicles, expenses, billing, and notifications. Authenticate with an API key or a session and you're ready to integrate.
Base URL
Production: https://yourdomain.com/api
Development: http://localhost:3000/apiOverride locally with the NEXT_PUBLIC_API_BASE_URL environment variable.
Quick start
- Authenticate — generate an API key from the dashboard.
- Make your first request — e.g. list events.
- Handle responses — read the errors and pagination contracts.
GET /api/events?page=1&limit=10 HTTP/1.1
Authorization: Bearer tke_live_aB3dE5gH7jK9mN1pQ3rS5tU7vW9xY1zA
Accept: application/jsonConventions
Every endpoint shares the same contracts for:
- Errors — envelope shape, status codes, recovery.
- Pagination —
page+limit+ envelope. - Rate limits — quotas and backoff headers.
- Idempotency — what's safe to retry.
- Request IDs — correlation for support.
- Versioning — what counts as breaking.
- Webhooks — verifying inbound deliveries.
Resources
| Group | Resources |
|---|---|
| Core | Events, Tours, Guests, Vehicles, Expenses, Vehicle assignments |
| Account | Users, API keys, Organizations, Invitations |
| Billing | Plans, Billing, Coupons, Referrals |
| Notifications | Notifications, Webhooks, Announcements |
| Admin | Audit logs, Impersonation, Settings |