v1
latestOpenAPI 3.1.02026-07-24700152.8 KBList tasks
Use this endpoint to retrieve all tasks for a specified property. When retrieving multiple tasks, include only one of the following path parameters in your request: home_id or reference_property_id
Query parameters
Property ID from Breezeway system. One of either home_id or reference_property_id is required.
Property ID from external system. One of either home_id or reference_property_id is required.
Company ID from external system; required if using cross-company access
Date range (YYYY-MM-DD) separated by comma, e.g. 2020-01-01,2020-03-31
Date range (YYYY-MM-DD) separated by comma, e.g. 2020-01-01,2020-03-31
Date range (YYYY-MM-DD) separated by comma, e.g. 2020-01-01,2020-03-31
Date range (YYYY-MM-DD) separated by comma, e.g. 2020-01-01,2020-03-31
Assignee IDs separated by commas, e.g. 7172,47634
Number of records returned per page
The page to return
Field to sort results by
Order to sort results in ('asc' or 'desc')
Response
200
Example response
{
"limit": 100,
"page": 1,
"results": [
{
"assignments": [
{
"assignee_id": 7172,
"id": 97937522,
"name": "Jennifer Brooks",
"type_task_user_status": "assigned"
}
],
"bill_to": "owner",
"costs": [
{
"cost": 10.5,
"created_at": "2024-09-25T18:57:57+00:00",
"description": "Shower curtain",
"id": 2063470,
"type_cost": {
"code": "material",
"id": 2,
"name": "Materials"
},
"updated_at": "2024-09-25T18:57:57+00:00"
}
],
"created_at": "2024-09-25T17:10:46",
"description": "Standard departure clean completed by Breezeway staff members. \nPlease Start and Complete the task from the Breezeway app to log your time.",
"finished_at": "2024-09-25T20:45:00",
"finished_by": {
"id": 7172,
"name": "Jennifer Brooks"
},
"home_id": 279892,
"id": 74589947,
"name": "Departure Clean",
"rate_paid": "250.00 USD",
"rate_type": "piece",
"report_url": "https://portal.breezeway.io/task/report/c279762b-e958-4b72-8433-86ddade1fc8d",
"requested_by": "property_services",
"scheduled_date": "2024-09-25",
"started_at": "2024-09-25T18:58:33",
"supplies": [
{
"billable": true,
"description": "Duracell",
"id": 11269633,
"markup_pricing_type": "flat_rate",
"markup_rate": 11,
"name": "AA Battery",
"quantity": 1,
"supply_id": 96142,
"total_price": 12.85,
"unit_cost": 1.85
}
],
"tags": [
"Clean Linens Delivery"
],
"task_tags": [
{
"id": 25033,
"name": "Clean Linens Delivery"
}
],
"template_id": 23027,
"total_time": "1:46:27",
"type_department": "housekeeping",
"type_priority": "normal",
"type_task_status": {
"code": "finished",
"name": "Finished",
"stage": "finished"
},
"updated_at": "2024-09-25T19:07:27+00:00"
}
],
"total_pages": 1,
"total_results": 1
}