DarOps API
Use the DarOps API to build mobile apps and integrations for properties, reservations, operational tasks, workers, earnings and billing.
Base URL
https://your-host.example/api/v1Authentication
Authorization: Bearer <API_TOKEN>API_TOKEN in the DarOps environment. API requests return 503 until a token is configured. Keep this token on trusted clients and servers.Conventions
- Successful responses use
{ "ok": true, "data": ... }. - Errors use
{ "ok": false, "error": "..." }. - Dates use
YYYY-MM-DD; timestamps use ISO 8601 UTC. - List endpoints return at most 500 rows.
Instance
/meApp information, current plan and entity counts.
/syncTrigger an iCal sync for all properties.
Properties
/propertiesList all properties.
/propertiesCreate a property.
Requires name. Accepts address, timezone, checkInTime, checkOutTime, icalUrl, playbook, defaultCleanerId and defaultAccessWorkerId.
/properties/:idGet one property and its reservations.
/properties/:idUpdate a property and regenerate its operational tasks.
/properties/:idDelete a property and its reservations and tasks.
/properties/:id/photosList a property's photos.
/properties/:id/photosUpload a JPEG, PNG or WebP image as raw bytes, up to 5 MB.
Reservations
/reservationsList reservations.
Filters: propertyId, from, to and status (confirmed or cancelled).
Tasks
/tasksList tasks with their property and assignee.
Filters: status, assigneeId, propertyId, from and to.
/tasksReport a maintenance issue or create an inspection task.
Requires propertyId and title. Also accepts type, description, priority, assigneeId, dueDate and dueTime.
/tasks/:idGet a task with its property, reservation and assignee.
/tasks/:idUpdate status, assignee or checklist progress.
Send status, assigneeId, toggleChecklistIndex, or a complete checklist array.
Workers
Workers are user accounts with a worker role and a cleaner, maintenance, access or manager job.
/workersList workers, including their avatar URL.
/workersCreate a worker account.
Requires name. Accepts phone, email and job.
/workers/:idGet one worker.
/workers/:idDelete a worker and unassign their tasks.
Import
/importBulk-import properties from listing or iCal URLs.
Send lines plus optional timezone, checkInTime and checkOutTime. Reservations are synchronized immediately when an iCal URL is present.
Earnings
/earningsGet weekly and monthly revenue, upcoming revenue and per-property totals.
Missing reservation amounts are estimated from the property's nightly rate and marked as estimates.
Notifications
/notifications?userId=:id&unread=1Get a user's latest notifications and unread count.
/notificationsMark selected notifications, or all notifications, as read.
Send userId and an optional ids array.
Billing
Usage charges accrue per property per month and per confirmed reservation.
/billingGet balance, rates, current usage, charges, bank details and payment history.
/billingCreate a bank-transfer top-up and receive a unique payment reference.
Examples
List a worker's open tasks
curl -H "Authorization: Bearer $API_TOKEN" \
"https://your-host.example/api/v1/tasks?assigneeId=2&status=open"Complete a task
curl -X PATCH \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"status":"done"}' \
https://your-host.example/api/v1/tasks/42Photo bytes are served separately at /api/photos/:id and avatars at /api/avatar/:userId. Both accept the same bearer token or an authenticated dashboard session.