Findable Partner API
  1. Deficiency Reports (a.k.a Red Flag Reports)
Findable Partner API
  • Documents
    • Get a specific document
      GET
    • Update document metadata
      PATCH
    • Delete a document
      DELETE
    • Get document processing status
      GET
    • List documents in a building
      GET
    • Create a new document upload request
      PUT
    • Search documents for a building owner
      GET
    • Get building category counts
      GET
    • Get documents by category
      GET
    • Search documents in a building
      GET
  • Buildings
    • List buildings for a building owner
      GET
    • Create a building for a building owner
      PUT
    • Get a building
      GET
    • Update a building
      PATCH
    • Delete a building
      DELETE
    • Get building processing status
      GET
  • Deficiency Reports (a.k.a Red Flag Reports)
    • List documents in deficiency report category
      GET
    • Add document to deficiency report category
      PUT
    • Remove document from deficiency report category
      DELETE
    • List deficiency reports for a building
      GET
    • Generate a new deficiency report
      POST
    • Get building deficiency report
      GET
  • Building owner
    • Get a building owner
      GET
    • Update a building owner
      PATCH
    • Delete a building owner
      DELETE
    • Get building owner processing status
      GET
    • List all building owners
      GET
    • Create a new building owner
      POST
  1. Deficiency Reports (a.k.a Red Flag Reports)

Generate a new deficiency report

POST
https://api.findable.ai/building_owners/{buildingOwnerId}/buildings/{buildingId}/reports/
Deficiency Reports
Last modified:2025-09-16 16:40:04
Generate or regenerate a deficiency report (red flag report) for a specific building. This is an asynchronous operation.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Default Response
Body

🟠400Bad Request
🟠403Forbidden
🟠404Not Found
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.findable.ai/building_owners//buildings//reports/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "country": "NO",
    "version": "v1"
}'
Response Response Example
200 - Example 1
{
    "message": "string",
    "buildingId": "string",
    "isGeneratingReport": true
}
Modified at 2025-09-16 16:40:04
Previous
List deficiency reports for a building
Next
Get building deficiency report
Built with