v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Task

Query Tasks

You can query schedule tasks (cleaning / maintain / reception / housekeeping / others) by making a request to this endpoint.

get/tasks

idinteger

Internal id of a specific task. When supplied, returns at most one entry (the matching task under the current operator).

offsetinteger

The starting point from which to begin returning results.

limitinteger

The maximum number of results to return. The maximum value is 100.

start_datestring date

The start of the expected date range to filter tasks by. The date format is YYYY-MM-DD. start_date and end_date must be supplied together.

end_datestring date

The end of the expected date range to filter tasks by. The date format is YYYY-MM-DD. start_date and end_date must be supplied together.

staff_idinteger

Filter tasks assigned to the given staff id.

property_idinteger

Filter tasks under the given property id.

type'cleaning' | 'maintenance' | 'reception' | 'room_service' | 'other'

Filter tasks by type.

status'pending' | 'in_progress' | 'completed' | 'cancelled'

Filter tasks by status.

A list of tasks with their details

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

{
  "error_msg": "Done."
}