Open dashboard
REST API · v1

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/v1

Authentication

Authorization: Bearer <API_TOKEN>
Set 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

GET/me

App information, current plan and entity counts.

POST/sync

Trigger an iCal sync for all properties.

Properties

GET/properties

List all properties.

POST/properties

Create a property.

Requires name. Accepts address, timezone, checkInTime, checkOutTime, icalUrl, playbook, defaultCleanerId and defaultAccessWorkerId.

GET/properties/:id

Get one property and its reservations.

PATCH/properties/:id

Update a property and regenerate its operational tasks.

DELETE/properties/:id

Delete a property and its reservations and tasks.

GET/properties/:id/photos

List a property's photos.

POST/properties/:id/photos

Upload a JPEG, PNG or WebP image as raw bytes, up to 5 MB.

Reservations

GET/reservations

List reservations.

Filters: propertyId, from, to and status (confirmed or cancelled).

Tasks

GET/tasks

List tasks with their property and assignee.

Filters: status, assigneeId, propertyId, from and to.

POST/tasks

Report a maintenance issue or create an inspection task.

Requires propertyId and title. Also accepts type, description, priority, assigneeId, dueDate and dueTime.

GET/tasks/:id

Get a task with its property, reservation and assignee.

PATCH/tasks/:id

Update 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.

GET/workers

List workers, including their avatar URL.

POST/workers

Create a worker account.

Requires name. Accepts phone, email and job.

GET/workers/:id

Get one worker.

DELETE/workers/:id

Delete a worker and unassign their tasks.

Import

POST/import

Bulk-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

GET/earnings

Get 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

GET/notifications?userId=:id&unread=1

Get a user's latest notifications and unread count.

POST/notifications

Mark 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.

GET/billing

Get balance, rates, current usage, charges, bank details and payment history.

POST/billing

Create 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/42

Photo 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.