/v1/inspections/{task_id}/findings/{unit_id}Authentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest example
Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.
curl --request PUT \
--url 'https://api.staging.facily.ai/v1/inspections/<TASK_ID>/findings/<UNIT_ID>' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"condition": "good",
"lock_check": "pass",
"note": "string"
}'Parameters
task_idpath · stringrequiredFormat: uuid
unit_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
conditionstring | nullgood, damaged, needs_cleaning or needs_repair; null or left out when the unit's condition was not checked. Anything but good makes the finding an issue.
Values: "good", "damaged", "needs_cleaning", "needs_repair"
Show condition schema
string | nullgood, damaged, needs_cleaning or needs_repair; null or left out when the unit's condition was not checked. Anything but good makes the finding an issue.
Variant 1: string
stringValues: "good", "damaged", "needs_cleaning", "needs_repair"
Variant 2: null
nulllock_checkstring | nullpass, fail, missing or skipped; null or left out when the lock was not checked. fail and missing make the finding an issue.
Values: "pass", "fail", "missing", "skipped"
Show lock_check schema
string | nullpass, fail, missing or skipped; null or left out when the lock was not checked. fail and missing make the finding an issue.
Variant 1: string
stringValues: "pass", "fail", "missing", "skipped"
Variant 2: null
nullnotestring | nullA note on the unit, up to 1,000 characters. Empty or only spaces is stored as null.
Max length: 1000
Show note schema
string | nullA note on the unit, up to 1,000 characters. Empty or only spaces is stored as null.
Variant 1: string
stringVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"condition": "string",
"follow_up": {
"kind": "string",
"status": "string",
"task_id": "00000000-0000-4000-8000-000000000001"
},
"is_issue": false,
"lock_check": "string",
"note": "string",
"photo_document_id": "00000000-0000-4000-8000-000000000001",
"recorded_by": {
"display_name": "string",
"id": "00000000-0000-4000-8000-000000000001"
},
"unit": {
"id": "00000000-0000-4000-8000-000000000001",
"is_deleted": false,
"unit_number": "string"
},
"updated_at": "2026-10-29T12:00:00Z"
},
"meta": {
"request_id": "string"
}
}application/json
dataInspectionFindingResponserequiredOne unit's finding on a round, as the findings list answers it.
Show data schema
conditionstring | nullrequiredgood, damaged, needs_cleaning or needs_repair; null when the condition was not checked.
Show condition schema
string | nullgood, damaged, needs_cleaning or needs_repair; null when the condition was not checked.
Variant 1: string
stringVariant 2: null
nullfollow_upInspectionFindingFollowUpResponse | nullrequiredThe follow-up work opened from this finding; null when none was, or its task was deleted. A cancelled follow-up still shows, cancelled.
Show follow_up schema
InspectionFindingFollowUpResponse | nullThe follow-up work opened from this finding; null when none was, or its task was deleted. A cancelled follow-up still shows, cancelled.
Variant 1: InspectionFindingFollowUpResponse
kindstringrequiredtask or work_order.
statusstringrequiredThe follow-up's task status: open, in_progress, completed or cancelled.
task_idstringrequiredThe follow-up's task id.
Format: uuid
Variant 2: null
nullis_issuebooleanrequiredTrue when the lock failed or is missing, or the condition is anything but good.
lock_checkstring | nullrequiredpass, fail, missing or skipped; null when the lock was not checked.
Show lock_check schema
string | nullpass, fail, missing or skipped; null when the lock was not checked.
Variant 1: string
stringVariant 2: null
nullnotestring | nullrequiredThe note on the unit; null for none.
Show note schema
string | nullThe note on the unit; null for none.
Variant 1: string
stringVariant 2: null
nullphoto_document_idstring | nullrequiredThe finding's photo, once its upload is confirmed and while it is not deleted; null otherwise. It is one of the task's photos.
Format: uuid
Show photo_document_id schema
string | nullThe finding's photo, once its upload is confirmed and while it is not deleted; null otherwise. It is one of the task's photos.
Variant 1: string
stringVariant 2: null
nullrecorded_byPersonResponserequiredA user, as a task or a thread entry names one.
Show recorded_by schema
display_namestringrequiredThe name to show for the user.
idstringrequiredThe user's id.
Format: uuid
unitInspectionFindingUnitResponserequiredThe unit a finding names. Never null: the unit number recorded with the finding stays when the unit is gone.
Show unit schema
idstring | nullrequiredThe unit's id; null once the unit has been removed for good.
Format: uuid
Show id schema
string | nullThe unit's id; null once the unit has been removed for good.
Variant 1: string
stringVariant 2: null
nullis_deletedbooleanrequiredTrue when the unit has been deleted.
unit_numberstringrequiredThe unit's number, as recorded with the finding.
updated_atstringrequiredWhen the finding's values were last recorded.
Format: date-time
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired