Skip to content

Tasks

The office keeps one to-do list: payments to chase, guest requests, maintenance, housekeeping, general. Some tasks are typed by staff, some are generated by the system (a payment due, a hold about to expire) — those carry automatic: true. Through the API a ticket system can put a maintenance job on the list and take it off again, and a dashboard can show what is overdue.

Scope read:tasks. Due date ascending.

Query parameterRequiredMeaning
statusnoopen covers open and in-progress tasks; otherwise exact: open, in_progress, done, cancelled
categorynopayment, guest_request, maintenance, housekeeping, general
from / tonoDue on or after / on or before
unitnoUnit slug
page / pageSizeno1-based page, 1–200 rows (default 100)
{
"tasks": [
{
"id": "0192d…",
"unitSlug": "marina-loft-2br",
"unitName": "Marina Loft · 2BR",
"bookingId": null,
"category": "maintenance",
"title": "AC unit in master bedroom rattling",
"details": "Reported by guest on 2 Sep; technician booked for Thursday",
"priority": "normal",
"dueDate": "2026-09-05",
"status": "in_progress",
"automatic": false,
"completedAt": null,
"createdAt": "2026-09-02T08:14:03.000Z",
"updatedAt": "2026-09-02T16:40:12.000Z"
}
],
"page": 1, "pageSize": 100, "totalItems": 23, "pageCount": 1
}

Scope read:tasks. One task; 404 NOT_FOUND otherwise.

Scope write:tasks. Creates a task with status open and returns it with 201.

Terminal window
curl -X POST https://api.myrentalcalendar.com/partner/v1/tasks \
-H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
-d '{
"title": "Replace smoke detector battery",
"category": "maintenance",
"priority": "low",
"dueDate": "2026-09-12",
"unit": "marina-loft-2br"
}'
FieldRequiredNotes
titleyes2–200 characters
dueDateyesISO date
categorynoDefault general
prioritynourgent, normal (default), low
detailsnoUp to 5000 characters
unitnoUnit slug the task concerns
bookingIdnoBooking the task concerns

404 NOT_FOUND for an unknown unit slug or booking id.

Scope write:tasks. Changes status, priority, due date, title or details — send only what changes. Setting status: "done" stamps completedAt; setting it back clears it.

{ "status": "done" }

Returns the updated task. 404 NOT_FOUND for an unknown id.

Every write is recorded in the agency’s audit trail with the key as the actor.