Exports
Admin export endpoints are grouped here so bulk data extraction is documented in one place.
For general conventions, see JSON-API Conventions. For authentication, see Authentication.
Prerequisites
- Bearer token with admin access
- Organization context (
?o={organization_id}) where required
Data Export Endpoints
These endpoints trigger a CSV/Excel export for a filtered dataset.
| Dataset | Endpoint |
|---|---|
| Bookings | GET /api/v1/bookings/export?o={org_id} |
| Customers | GET /api/v1/customers/export?o={org_id} |
| Orders | GET /api/v1/orders/export?o={org_id} |
| Vouchers | GET /api/v1/vouchers/export?o={org_id} |
| Invoices | GET /api/v1/invoices/export?o={org_id} |
| Booking Passes | GET /api/v1/booking-passes/export?o={org_id} |
The resource-specific export endpoints accept the same filter parameters as their corresponding list endpoints.
Export Jobs
Use the export job endpoints to inspect generated exports and manage retries or downloads.
| Action | Endpoint |
|---|---|
| List exports | GET /api/v1/exports?o={org_id} |
| Get one export | GET /api/v1/exports/{record}?o={org_id} |
| Download export file | GET /api/v1/exports/{record}/download?o={org_id} |
| Cancel export | GET /api/v1/exports/{record}/cancel?o={org_id} |
| Retry export | GET /api/v1/exports/{record}/retry?o={org_id} |
Export Destinations
Export destinations define where scheduled exports are delivered.
| Action | Endpoint |
|---|---|
| List destinations | GET /api/v1/export-destinations?o={org_id} |
| Create destination | POST /api/v1/export-destinations?o={org_id} |
| Get destination | GET /api/v1/export-destinations/{record}?o={org_id} |
| Update destination | PATCH /api/v1/export-destinations/{record}?o={org_id} |
| Delete destination | DELETE /api/v1/export-destinations/{record}?o={org_id} |
| Test connection | GET /api/v1/export-destinations/{record}/test-connection?o={org_id} |
Export Schedules
Export schedules automate recurring exports.
| Action | Endpoint |
|---|---|
| List schedules | GET /api/v1/export-schedules?o={org_id} |
| Create schedule | POST /api/v1/export-schedules?o={org_id} |
| Get schedule | GET /api/v1/export-schedules/{record}?o={org_id} |
| Update schedule | PATCH /api/v1/export-schedules/{record}?o={org_id} |
| Delete schedule | DELETE /api/v1/export-schedules/{record}?o={org_id} |
| Duplicate schedule | GET /api/v1/export-schedules/{record}/duplicate?o={org_id} |
| Run schedule now | GET /api/v1/export-schedules/{record}/run?o={org_id} |
