List tasks
query Parameters
sizePage size (max 100)
pageZero-based page index (default 0)
property_idRestrict to tasks for a single property
assigned_toFilter by assigned user id
statusFilter by task status (pending, in_progress, completed, cancelled)
task_typeFilter by task type (cleaning, maintenance, booking, block)
scheduled_fromOnly tasks scheduled on or after this date (ISO-8601)
scheduled_toOnly tasks scheduled on or before this date (ISO-8601)
include_cancelledInclude cancelled tasks when true (default false)
List tasks › Responses
Paginated tasks. When property_id is omitted, returns tasks from owned properties plus tasks assigned to the caller.
Create a task
Create a task › Request Body
property_idtask_typescheduled_datescheduled_start_timescheduled_end_timebooking_idassigned_tonotesCreate a task › Responses
The created task
idtask_typestatusassigned_toassigned_to_namescheduled_datescheduled_start_timescheduled_end_timecreated_atbooking_idnotesjob_reportstarted_atcompleted_atcancelled_ataccesspublic_tokenGet a task by id
path Parameters
idTask id
Get a task by id › Responses
The task. Contractors viewing a cleaning task receive the next-booking context embedded in the task.
idtask_typestatusassigned_toassigned_to_namescheduled_datescheduled_start_timescheduled_end_timecreated_atbooking_idnotesjob_reportstarted_atcompleted_atcancelled_ataccesspublic_tokenUpdate a task
Owners can update all fields. Crew members may only update job_report.
path Parameters
idTask id
Update a task › Request Body
assigned_tonotesstatusjob_reportUpdate a task › Responses
The updated task
idtask_typestatusassigned_toassigned_to_namescheduled_datescheduled_start_timescheduled_end_timecreated_atbooking_idnotesjob_reportstarted_atcompleted_atcancelled_ataccesspublic_tokenStart a task
Marks the task as in_progress. Only the assigned crew member or an owner can start a task, and the task must be in pending status.
path Parameters
idTask id
Start a task › Responses
The task with its status set to in_progress
idtask_typestatusassigned_toassigned_to_namescheduled_datescheduled_start_timescheduled_end_timecreated_atbooking_idnotesjob_reportstarted_atcompleted_atcancelled_ataccesspublic_tokenComplete a task
Marks the task as completed. Only the assigned crew member or an owner can complete a task, and the task must be in in_progress status.
path Parameters
idTask id
Complete a task › Responses
The task with its status set to completed
idtask_typestatusassigned_toassigned_to_namescheduled_datescheduled_start_timescheduled_end_timecreated_atbooking_idnotesjob_reportstarted_atcompleted_atcancelled_ataccesspublic_tokenList tasks for a property
path Parameters
idProperty id
query Parameters
sizePage size (max 100)
pageZero-based page index (default 0)
statusFilter by task status
include_cancelledInclude cancelled tasks when true (default false)
List tasks for a property › Responses
Paginated tasks for the property
Get a task by public token (no auth)
Unauthenticated access for contractors via a shareable link. The token expires 7 days after the task's scheduled date.
path Parameters
tokenPublic task token
Get a task by public token (no auth) › Responses
The task, rendered with contractor-level visibility
idtask_typestatusassigned_toassigned_to_namescheduled_datescheduled_start_timescheduled_end_timecreated_atbooking_idnotesjob_reportstarted_atcompleted_atcancelled_ataccesspublic_token