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

List Inspection Findings

Tasks · REST API reference

Get support
GET/v1/inspections/{task_id}/findings
One page of a round's findings, by the unit number recorded with each, then by 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 GET \
  --url 'https://api.staging.facily.ai/v1/inspections/<TASK_ID>/findings' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

task_idpath · stringrequired

Format: uuid

cursorquery · string | null

The cursor of the previous page, to read the next one.

limitquery · integer

How many findings a page holds, from 1 to 200.

Default: 100 · Minimum: 1 · Maximum: 200

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"
  },
  "pagination": {
    "has_more": false,
    "limit": 0,
    "cursor": "string",
    "total_count": 0
  },
  "metrics": {
    "cards": {},
    "computed_at": "2026-10-29T12:00:00Z",
    "is_stale": false,
    "scope": "facility"
  }
}

application/json

dataInspectionFindingResponse[]required
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
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
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

List Inspection Findings | Facily Developers