v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

Retrieve task requirements

Retrieve user responses to completed tasks

get/task/{id}/requirements

Path parameters

idinteger required

Task ID from Breezeway system

Response

200

actionstring[]

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

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

photo_requiredboolean

responsestring

section_namestring

type_requirementstring

Example response

[
  {
    "action": [
      "Fold the towels a certain way"
    ],
    "response": "check",
    "section_name": "Interior",
    "type_requirement": "checklist"
  }
]