Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsRecord Inspection Finding
Search the full API reference Esc to close

Record Inspection Finding

Tasks · REST API reference

Get support
PUT/v1/inspections/{task_id}/findings/{unit_id}
Record one unit's finding on a round, or replace it. Answers the finding.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request 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
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"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

task_idpath · stringrequired

Format: uuid

unit_idpath · stringrequired

Format: uuid

Request body

application/json · Required

conditionstring | null

good, 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 | null

good, 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
string

Values: "good", "damaged", "needs_cleaning", "needs_repair"

Variant 2: null
null
lock_checkstring | null

pass, 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 | null

pass, 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
string

Values: "pass", "fail", "missing", "skipped"

Variant 2: null
null
notestring | null

A note on the unit, up to 1,000 characters. Empty or only spaces is stored as null.

Max length: 1000

Show note schema
string | null

A note on the unit, up to 1,000 characters. Empty or only spaces is stored as null.

Variant 1: string
string
Variant 2: null
null

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "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

dataInspectionFindingResponserequired

One unit's finding on a round, as the findings list answers it.

Show data schema
conditionstring | nullrequired

good, damaged, needs_cleaning or needs_repair; null when the condition was not checked.

Show condition schema
string | null

good, damaged, needs_cleaning or needs_repair; null when the condition was not checked.

Variant 1: string
string
Variant 2: null
null
follow_upInspectionFindingFollowUpResponse | nullrequired

The 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 | null

The 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
kindstringrequired

task or work_order.

statusstringrequired

The follow-up's task status: open, in_progress, completed or cancelled.

task_idstringrequired

The follow-up's task id.

Format: uuid

Variant 2: null
null
is_issuebooleanrequired

True when the lock failed or is missing, or the condition is anything but good.

lock_checkstring | nullrequired

pass, fail, missing or skipped; null when the lock was not checked.

Show lock_check schema
string | null

pass, fail, missing or skipped; null when the lock was not checked.

Variant 1: string
string
Variant 2: null
null
notestring | nullrequired

The note on the unit; null for none.

Show note schema
string | null

The note on the unit; null for none.

Variant 1: string
string
Variant 2: null
null
photo_document_idstring | nullrequired

The 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 | null

The 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
string
Variant 2: null
null
recorded_byPersonResponserequired

A user, as a task or a thread entry names one.

Show recorded_by schema
display_namestringrequired

The name to show for the user.

idstringrequired

The user's id.

Format: uuid

unitInspectionFindingUnitResponserequired

The unit a finding names. Never null: the unit number recorded with the finding stays when the unit is gone.

Show unit schema
idstring | nullrequired

The unit's id; null once the unit has been removed for good.

Format: uuid

Show id schema
string | null

The unit's id; null once the unit has been removed for good.

Variant 1: string
string
Variant 2: null
null
is_deletedbooleanrequired

True when the unit has been deleted.

unit_numberstringrequired

The unit's number, as recorded with the finding.

updated_atstringrequired

When the finding's values were last recorded.

Format: date-time

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll tasks operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Record Inspection Finding | Facily Developers