v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

Retrieve task

get/task/{id}

Path parameters

idinteger required

Task ID from Breezeway system

Response

200

bill_tostring

created_atstring

{"stackTrail":"paths:/task/{id}:get:responses:200:content:application/json:schema:properties:created_by","oasType":"schema","type":"unknown"}

descriptionstring

finished_atstring

home_idinteger

idinteger

namestring

pausedboolean

rate_paidstring

rate_typestring

{"stackTrail":"paths:/task/{id}:get:responses:200:content:application/json:schema:properties:reference_property_id","oasType":"schema","type":"unknown"}

report_urlstring

requested_bystring

scheduled_datestring

scheduled_timestring

started_atstring

tagsstring[]

template_idinteger

total_timestring

type_departmentstring

type_prioritystring

updated_atstring

Example response

{
  "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-10-25",
  "scheduled_time": "14:00:00",
  "started_at": "2024-09-25T18:58:33",
  "subdepartment": {
    "id": 46,
    "name": "Delicate Surfaces Cleaning"
  },
  "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-25T18:59:34+00:00"
}