API reference
Field inspections for HOA management companies. Version 2026-11-01.
In design. These endpoints are the planned server API and are not live yet. Webhook payloads are already produced by the app; see Webhooks.
Basics
| Environment | Base URL |
| Sandbox (hc_test_ keys, fictional data) | https://sandbox.api.hoacraft.com/v1 |
| Production (hc_live_ keys) | https://api.hoacraft.com/v1 |
Authenticate with Authorization: Bearer <key>. hc_test_… (sandbox) or hc_live_… (production) key. List endpoints are paged with cursor and limit; follow next_cursor until it is null. Errors return Error.
Import
Your system pushes communities and properties so inspectors drive with
the right map, and so every payload carries your own ids.
Communities & properties: how it flows, events and samples →
Violations
Read violations HOACraft recorded (the pull alternative to webhooks).
Violations: how it flows, events and samples →
List violations
GET/violations
Parameters
| community_idquery · string | |
| statusquery · string | One of: open resolved |
| updated_sincequery · string (date-time) | Only violations created, re-checked or resolved after this time. |
| cursorquery · string | |
| limitquery · integer | default 100 · min 1 · max 500 |
Responses
| 200 | A page of violations, oldest change first.object |
Example request
curl -X GET "https://sandbox.api.hoacraft.com/v1/violations" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
{
"data": [
{
"id": "f-ho4l8rev40-3",
"status": "open",
"location": {
"kind": "property",
"id": "willow-creek-p02",
"lot_number": "Lot 02",
"address": "103 Willow Creek Dr",
"geo": {
"lat": 30.544895,
"lng": -97.692616
}
},
"issue_type": "landscaping",
"title": "Lawn not maintained",
"description": "Turf about 8 in, weeds in beds.",
"level": 1,
"suggested_stage": "Courtesy notice",
"cure_by": "2026-11-27T16:00:00.000Z",
"rules": [
{
"id": "wce-ccr-7.1",
"document": "CC&Rs",
"section": "7.1",
"title": "Lawn and Landscape Maintenance"
}
],
"photos": [
{
"id": "ph-ho4l8rev40-2",
"url": "https://files.hoacraft.com/photos/ph-ho4l8rev40-2.jpg",
"taken_at": "2026-11-13T16:00:00.000Z",
"demo": true
}
],
"observed_at": "2026-11-13T16:00:00.000Z",
"observed_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"approved_at": "2026-11-13T16:00:00.000Z",
"approved_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"session_id": "sess-ho4l8rev40-0",
"ai_assisted": true,
"ai_confidence": 0.86,
"rechecks": [],
"resolved_at": null,
"resolution": null
}
],
"next_cursor": "string"
}
Get a violation
GET/violations/{violationId}
Parameters
| violationIdrequiredpath · string | |
Responses
Example request
curl -X GET "https://sandbox.api.hoacraft.com/v1/violations/f-ho4l8rev40-3" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
{
"id": "f-ho4l8rev40-3",
"status": "open",
"location": {
"kind": "property",
"id": "willow-creek-p02",
"lot_number": "Lot 02",
"address": "103 Willow Creek Dr",
"geo": {
"lat": 30.544895,
"lng": -97.692616
}
},
"issue_type": "landscaping",
"title": "Lawn not maintained",
"description": "Turf about 8 in, weeds in beds.",
"level": 1,
"suggested_stage": "Courtesy notice",
"cure_by": "2026-11-27T16:00:00.000Z",
"rules": [
{
"id": "wce-ccr-7.1",
"document": "CC&Rs",
"section": "7.1",
"title": "Lawn and Landscape Maintenance"
}
],
"photos": [
{
"id": "ph-ho4l8rev40-2",
"url": "https://files.hoacraft.com/photos/ph-ho4l8rev40-2.jpg",
"taken_at": "2026-11-13T16:00:00.000Z",
"demo": true
}
],
"observed_at": "2026-11-13T16:00:00.000Z",
"observed_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"approved_at": "2026-11-13T16:00:00.000Z",
"approved_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"session_id": "sess-ho4l8rev40-0",
"ai_assisted": true,
"ai_confidence": 0.86,
"rechecks": [],
"resolved_at": null,
"resolution": null
}
Update from your system (after a letter, or when you close it)
PATCH/violations/{violationId}
Parameters
| violationIdrequiredpath · string | |
Request body
| external_idstring | Your violation/case id. |
| stagestring | Stage you are at, e.g. "First violation notice". |
| cure_bystring (date-time) | Next re-check date. |
| statusstring | One of: open resolved |
| resolutionstring | e.g. "Fine paid, closed". |
Responses
Example request
curl -X PATCH "https://sandbox.api.hoacraft.com/v1/violations/f-ho4l8rev40-3" \
-H "Authorization: Bearer $HOACRAFT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"external_id": "string",
"stage": "string",
"cure_by": "2026-11-13T16:00:00Z",
"status": "open",
"resolution": "string"
}'
Example response
{
"id": "f-ho4l8rev40-3",
"status": "open",
"location": {
"kind": "property",
"id": "willow-creek-p02",
"lot_number": "Lot 02",
"address": "103 Willow Creek Dr",
"geo": {
"lat": 30.544895,
"lng": -97.692616
}
},
"issue_type": "landscaping",
"title": "Lawn not maintained",
"description": "Turf about 8 in, weeds in beds.",
"level": 1,
"suggested_stage": "Courtesy notice",
"cure_by": "2026-11-27T16:00:00.000Z",
"rules": [
{
"id": "wce-ccr-7.1",
"document": "CC&Rs",
"section": "7.1",
"title": "Lawn and Landscape Maintenance"
}
],
"photos": [
{
"id": "ph-ho4l8rev40-2",
"url": "https://files.hoacraft.com/photos/ph-ho4l8rev40-2.jpg",
"taken_at": "2026-11-13T16:00:00.000Z",
"demo": true
}
],
"observed_at": "2026-11-13T16:00:00.000Z",
"observed_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"approved_at": "2026-11-13T16:00:00.000Z",
"approved_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"session_id": "sess-ho4l8rev40-0",
"ai_assisted": true,
"ai_confidence": 0.86,
"rechecks": [],
"resolved_at": null,
"resolution": null
}
Work orders
Maintenance issues an inspector spots in the field, usually in common areas
or where the association maintains the item. HOACraft sends each submitted
work order to your system; drafts stay on the phone. Vendor billing and
payment stay with you.
Work orders: how it flows, events and samples →
List work orders
GET/work-orders
Parameters
| community_idquery · string | |
| statusquery · string | |
| updated_sincequery · string (date-time) | |
| cursorquery · string | |
| limitquery · integer | default 100 · min 1 · max 500 |
Responses
| 200 | A page of work orders, oldest change first.object |
Example request
curl -X GET "https://sandbox.api.hoacraft.com/v1/work-orders" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
{
"data": [
{
"id": "wo-ho4l8rev40-b",
"number": 106,
"status": "completed",
"location": {
"kind": "common_area",
"id": "wce-ca-pool",
"address": "Pool & Clubhouse",
"geo": {
"lat": 30.544838,
"lng": -97.690914
}
},
"title": "Pool gate latch broken",
"category": "fencingGates",
"priority": "urgent",
"description": "Latch does not catch; gate will not self-close.",
"vendor": {
"id": "v-ssh",
"name": "SSH Gates & Access"
},
"due_date": null,
"follow_up_date": null,
"photos": [],
"created_at": "2026-11-13T16:00:00.000Z",
"created_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"ai_assisted": false,
"completed_at": "2026-11-13T16:00:00.000Z",
"completion_notes": "Latch and closer replaced, tested"
}
],
"next_cursor": "string"
}
Get a work order
GET/work-orders/{workOrderId}
Parameters
| workOrderIdrequiredpath · string | |
Responses
Example request
curl -X GET "https://sandbox.api.hoacraft.com/v1/work-orders/wo-ho4l8rev40-b" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
{
"id": "wo-ho4l8rev40-b",
"number": 106,
"status": "completed",
"location": {
"kind": "common_area",
"id": "wce-ca-pool",
"address": "Pool & Clubhouse",
"geo": {
"lat": 30.544838,
"lng": -97.690914
}
},
"title": "Pool gate latch broken",
"category": "fencingGates",
"priority": "urgent",
"description": "Latch does not catch; gate will not self-close.",
"vendor": {
"id": "v-ssh",
"name": "SSH Gates & Access"
},
"due_date": null,
"follow_up_date": null,
"photos": [],
"created_at": "2026-11-13T16:00:00.000Z",
"created_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"ai_assisted": false,
"completed_at": "2026-11-13T16:00:00.000Z",
"completion_notes": "Latch and closer replaced, tested"
}
Update from your system (vendor assigned, work done, cancelled)
PATCH/work-orders/{workOrderId}
Use this when the vendor workflow runs in your system, so the inspector
sees the current status and can check the work on the next drive. Status
changes follow the same rules as the app: open → assigned → in_progress →
completed, with cancel and reopen.
Parameters
| workOrderIdrequiredpath · string | |
Request body
| external_idstring | Your work order id. |
| statusstring | One of: open assigned inProgress completed cancelled |
| vendor_external_idstring · nullable | Your vendor id. Imported vendors only. |
| due_datestring (date-time) · nullable | |
| completion_notesstring | Required when status is completed. |
Responses
| 200 | UpdatedWorkOrder |
| 404 | Not foundError |
| 409 | The status change is not allowed from the current status.Error |
Example request
curl -X PATCH "https://sandbox.api.hoacraft.com/v1/work-orders/wo-ho4l8rev40-b" \
-H "Authorization: Bearer $HOACRAFT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"external_id": "string",
"status": "open",
"vendor_external_id": "string",
"due_date": "2026-11-13T16:00:00Z",
"completion_notes": "string"
}'
Example response
{
"id": "wo-ho4l8rev40-b",
"number": 106,
"status": "completed",
"location": {
"kind": "common_area",
"id": "wce-ca-pool",
"address": "Pool & Clubhouse",
"geo": {
"lat": 30.544838,
"lng": -97.690914
}
},
"title": "Pool gate latch broken",
"category": "fencingGates",
"priority": "urgent",
"description": "Latch does not catch; gate will not self-close.",
"vendor": {
"id": "v-ssh",
"name": "SSH Gates & Access"
},
"due_date": null,
"follow_up_date": null,
"photos": [],
"created_at": "2026-11-13T16:00:00.000Z",
"created_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"ai_assisted": false,
"completed_at": "2026-11-13T16:00:00.000Z",
"completion_notes": "Latch and closer replaced, tested"
}
ACC
Architectural change requests. Homeowners apply through your portal; you
push the requests that need a site visit, the inspector reviews them on the
drive, and HOACraft sends the review back. A site review is a
recommendation only. The committee decision is yours to record.
ACC requests: how it flows, events and samples →
List ACC requests
GET/acc-requests
Parameters
| community_idquery · string | |
| statusquery · string | |
| updated_sincequery · string (date-time) | |
| cursorquery · string | |
| limitquery · integer | default 100 · min 1 · max 500 |
Responses
| 200 | A page of ACC requests, oldest change first.object |
Example request
curl -X GET "https://sandbox.api.hoacraft.com/v1/acc-requests" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
{
"data": [
{
"id": "acc-wce-201",
"number": 201,
"status": "approvedWithConditions",
"location": {
"kind": "property",
"id": "willow-creek-p07",
"lot_number": "Lot 07",
"address": "113 Willow Creek Dr",
"geo": {
"lat": 30.54713,
"lng": -97.692082
}
},
"request_type": "fence",
"title": "Replace rear and side fence",
"description": "Replace the existing 6 ft fence along rear and left side with new cedar board-on-board, stained Weathered Grey. Same footprint as current fence.",
"applicant_name": "Owner of record",
"requested_at": "2026-11-08T18:00:00.000Z",
"documents": [
{
"name": "Site plan.pdf",
"kind": "plan"
},
{
"name": "Contractor quote.pdf",
"kind": "quote"
}
],
"site_reviews": [
{
"id": "sr-ho4l8rev40-i",
"at": "2026-11-13T16:00:00.000Z",
"by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"outcome": "recommendApproval",
"observations": "Old fence runs on the survey line; no easement conflict.",
"measurements": "Proposed height 6 ft, matches neighbours",
"rules": [
{
"id": "wce-adg-3.4",
"document": "Design Guidelines",
"section": "3.4",
"title": "Fences"
}
],
"photos": [],
"session_id": "sess-ho4l8rev40-0"
}
],
"decision": {
"decision": "approvedWithConditions",
"decided_at": "2026-11-13T16:00:00.000Z",
"recorded_by": {
"id": "staff-marcus",
"name": "Marcus Lee"
},
"conditions": "Stain within 60 days to an Earth Palette colour."
}
}
],
"next_cursor": "string"
}
Get an ACC request with its site reviews
GET/acc-requests/{accRequestId}
Parameters
| accRequestIdrequiredpath · string | |
Responses
Example request
curl -X GET "https://sandbox.api.hoacraft.com/v1/acc-requests/acc-wce-201" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
{
"id": "acc-wce-201",
"number": 201,
"status": "approvedWithConditions",
"location": {
"kind": "property",
"id": "willow-creek-p07",
"lot_number": "Lot 07",
"address": "113 Willow Creek Dr",
"geo": {
"lat": 30.54713,
"lng": -97.692082
}
},
"request_type": "fence",
"title": "Replace rear and side fence",
"description": "Replace the existing 6 ft fence along rear and left side with new cedar board-on-board, stained Weathered Grey. Same footprint as current fence.",
"applicant_name": "Owner of record",
"requested_at": "2026-11-08T18:00:00.000Z",
"documents": [
{
"name": "Site plan.pdf",
"kind": "plan"
},
{
"name": "Contractor quote.pdf",
"kind": "quote"
}
],
"site_reviews": [
{
"id": "sr-ho4l8rev40-i",
"at": "2026-11-13T16:00:00.000Z",
"by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"outcome": "recommendApproval",
"observations": "Old fence runs on the survey line; no easement conflict.",
"measurements": "Proposed height 6 ft, matches neighbours",
"rules": [
{
"id": "wce-adg-3.4",
"document": "Design Guidelines",
"section": "3.4",
"title": "Fences"
}
],
"photos": [],
"session_id": "sess-ho4l8rev40-0"
}
],
"decision": {
"decision": "approvedWithConditions",
"decided_at": "2026-11-13T16:00:00.000Z",
"recorded_by": {
"id": "staff-marcus",
"name": "Marcus Lee"
},
"conditions": "Stain within 60 days to an Earth Palette colour."
}
}
Record the committee decision
POST/acc-requests/{accRequestId}/decision
Closes the request in HOACraft and takes it off the drive. A decision
can be recorded once. HOACraft never approves or denies on its own.
Parameters
| accRequestIdrequiredpath · string | |
Request body
| decisionrequiredstring | One of: approved approvedWithConditions denied |
| decided_atrequiredstring (date-time) | |
| conditionsstring | |
Responses
Example request
curl -X POST "https://sandbox.api.hoacraft.com/v1/acc-requests/acc-wce-201/decision" \
-H "Authorization: Bearer $HOACRAFT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"decision": "approved",
"decided_at": "2026-11-13T16:00:00Z",
"conditions": "string"
}'
Example response
{
"id": "acc-wce-201",
"number": 201,
"status": "approvedWithConditions",
"location": {
"kind": "property",
"id": "willow-creek-p07",
"lot_number": "Lot 07",
"address": "113 Willow Creek Dr",
"geo": {
"lat": 30.54713,
"lng": -97.692082
}
},
"request_type": "fence",
"title": "Replace rear and side fence",
"description": "Replace the existing 6 ft fence along rear and left side with new cedar board-on-board, stained Weathered Grey. Same footprint as current fence.",
"applicant_name": "Owner of record",
"requested_at": "2026-11-08T18:00:00.000Z",
"documents": [
{
"name": "Site plan.pdf",
"kind": "plan"
},
{
"name": "Contractor quote.pdf",
"kind": "quote"
}
],
"site_reviews": [
{
"id": "sr-ho4l8rev40-i",
"at": "2026-11-13T16:00:00.000Z",
"by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"outcome": "recommendApproval",
"observations": "Old fence runs on the survey line; no easement conflict.",
"measurements": "Proposed height 6 ft, matches neighbours",
"rules": [
{
"id": "wce-adg-3.4",
"document": "Design Guidelines",
"section": "3.4",
"title": "Fences"
}
],
"photos": [],
"session_id": "sess-ho4l8rev40-0"
}
],
"decision": {
"decision": "approvedWithConditions",
"decided_at": "2026-11-13T16:00:00.000Z",
"recorded_by": {
"id": "staff-marcus",
"name": "Marcus Lee"
},
"conditions": "Stain within 60 days to an Earth Palette colour."
}
}
Drives
A drive is one inspector's pass through a community. Its summary is the
inspection record: which homes were passed, which were skipped and why,
and what was found.
Drives: how it flows, events and samples →
List completed drives
GET/drives
Parameters
| community_idquery · string | |
| sincequery · string (date-time) | |
| cursorquery · string | |
| limitquery · integer | default 100 · min 1 · max 500 |
Responses
| 200 | A page of drives.object |
Example request
curl -X GET "https://sandbox.api.hoacraft.com/v1/drives" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
{
"data": [
{
"id": "sess-ho4l8rev40-0",
"title": "Open items: Nov 13",
"started_at": "2026-11-13T16:00:00.000Z",
"ended_at": "2026-11-13T16:00:00.000Z",
"inspector": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"stops": {
"total": 7,
"completed": 0,
"skipped": []
},
"violations_created": [
"f-ho4l8rev40-3"
],
"rechecks": [
{
"violation_id": "f-ho4l8rev40-3",
"result": "fixed"
},
{
"violation_id": "f-wce-3",
"result": "still_open"
}
]
}
],
"next_cursor": "string"
}
Webhooks
Manage webhook endpoints and replay events.
List endpoints
GET/webhook-endpoints
Responses
Example request
curl -X GET "https://sandbox.api.hoacraft.com/v1/webhook-endpoints" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
[
{
"id": "string",
"url": "https://pm.example.com/integrations/hoacraft/webhook",
"events": [
"violation.created"
],
"enabled": true,
"created_at": "2026-11-13T16:00:00Z"
}
]
Register an endpoint
POST/webhook-endpoints
The signing secret is returned once, in this response.
Request body
| urlrequiredstring (uri) | matches ^https:// |
| eventsarray of EventType | Omit for all event types. |
Responses
Example request
curl -X POST "https://sandbox.api.hoacraft.com/v1/webhook-endpoints" \
-H "Authorization: Bearer $HOACRAFT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://pm.example.com/integrations/hoacraft/webhook",
"events": [
"violation.created"
]
}'
Example response
{
"id": "string",
"url": "https://pm.example.com/integrations/hoacraft/webhook",
"events": [
"violation.created"
],
"enabled": true,
"created_at": "2026-11-13T16:00:00Z",
"secret": "whsec_…"
}
Rotate the signing secret
POST/webhook-endpoints/{endpointId}/rotate-secret
The old secret keeps working for 24 hours so you can deploy the new one.
Parameters
| endpointIdrequiredpath · string | |
Responses
Example request
curl -X POST "https://sandbox.api.hoacraft.com/v1/webhook-endpoints/we_8f2k1/rotate-secret" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
{
"secret": "string"
}
Send a webhook.test event
POST/webhook-endpoints/{endpointId}/test
Parameters
| endpointIdrequiredpath · string | |
Responses
Example request
curl -X POST "https://sandbox.api.hoacraft.com/v1/webhook-endpoints/we_8f2k1/test" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
List or replay recent events (30 days)
GET/events
Parameters
| typequery · EventType | |
| sincequery · string (date-time) | |
| delivery_statusquery · string | One of: delivered failed pending |
| cursorquery · string | |
Responses
| 200 | Events, same envelopes as the webhook bodies.object |
Example request
curl -X GET "https://sandbox.api.hoacraft.com/v1/events" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
{
"data": [
{
"id": "evt-ho4l8rev40-p",
"type": "webhook.test",
"api_version": "2026-11-01",
"created_at": "2026-11-13T16:00:00.000Z",
"community": {
"id": "willow-creek",
"name": "Willow Creek Estates"
},
"data": {
"message": "Hello from HOACraft. Your endpoint is reachable."
}
}
],
"next_cursor": "string"
}
Schemas
EventType
string
One of: violation.created violation.still_open violation.resolved work_order.created work_order.updated work_order.completed acc_request.site_reviewed acc_request.decided drive.completed webhook.test
Event
| idrequiredstring | Unique per event. Retries reuse it; dedupe on it. |
| typerequiredEventType | |
| api_versionrequiredstring | e.g. 2026-11-01 |
| created_atrequiredstring (date-time) | |
| communityrequiredobject | 2 fields| idrequiredstring | | | namerequiredstring | |
|
| datarequiredobject | |
Example
{
"id": "evt-ho4l8rev40-p",
"type": "webhook.test",
"api_version": "2026-11-01",
"created_at": "2026-11-13T16:00:00.000Z",
"community": {
"id": "willow-creek",
"name": "Willow Creek Estates"
},
"data": {
"message": "Hello from HOACraft. Your endpoint is reachable."
}
}
RecheckEvent
| idrequiredstring | Unique per event. Retries reuse it; dedupe on it. |
| typerequiredEventType | |
| api_versionrequiredstring | e.g. 2026-11-01 |
| created_atrequiredstring (date-time) | |
| communityrequiredobject | 2 fields| idrequiredstring | | | namerequiredstring | |
|
| datarequiredobject | 2 fields |
Example
{
"id": "evt-ho4l8rev40-8",
"type": "violation.still_open",
"api_version": "2026-11-01",
"created_at": "2026-11-13T16:00:00.000Z",
"community": {
"id": "willow-creek",
"name": "Willow Creek Estates"
},
"data": {
"violation": {
"id": "f-wce-3",
"status": "open",
"location": {
"kind": "property",
"id": "willow-creek-p12",
"lot_number": "Lot 12",
"address": "123 Willow Creek Dr",
"geo": {
"lat": 30.546254,
"lng": -97.689211
}
},
"issue_type": "landscaping",
"title": "Lawn not maintained (repeat)",
"description": "Turf still overgrown at follow-up; no visible change since courtesy notice.",
"level": 2,
"suggested_stage": "First violation notice",
"cure_by": "2026-11-27T16:00:00.000Z",
"rules": [
{
"id": "wce-ccr-7.1",
"document": "CC&Rs",
"section": "7.1",
"title": "Lawn and Landscape Maintenance"
}
],
"photos": [
{
"id": "ph-willow-creek-2",
"url": "https://files.hoacraft.com/photos/ph-willow-creek-2.jpg",
"taken_at": "2026-10-06T15:40:00.000Z",
"demo": true
}
],
"observed_at": "2026-10-06T15:30:00.000Z",
"observed_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"approved_at": "2026-10-06T17:00:00.000Z",
"approved_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"session_id": null,
"ai_assisted": false,
"ai_confidence": null,
"rechecks": [
{
"at": "2026-11-13T16:00:00.000Z",
"by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"result": "still_open",
"note": "No visible change",
"photos": []
}
],
"resolved_at": null,
"resolution": null
},
"recheck": {
"at": "2026-11-13T16:00:00.000Z",
"by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"result": "still_open",
"note": "No visible change",
"photos": []
}
}
}
Person
| idrequiredstring | |
| namerequiredstring | |
Example
{
"id": "staff-dana",
"name": "Dana Whitfield"
}
Location
| kindrequiredstring | One of: property common_area |
| idrequiredstring | HOACraft id. |
| external_idstring | Your id |
| lot_numberstring | Properties only. |
| addressrequiredstring | Street address |
| geoobject | 2 fields |
Example
{
"kind": "property",
"id": "willow-creek-p02",
"lot_number": "Lot 02",
"address": "103 Willow Creek Dr",
"geo": {
"lat": 30.544895,
"lng": -97.692616
}
}
Photo
| idrequiredstring | |
| urlrequiredstring (uri) | Signed link |
| taken_atrequiredstring (date-time) | |
| demoboolean | True for bundled sample photos (demo and sandbox only). |
Example
{
"id": "ph-ho4l8rev40-2",
"url": "https://files.hoacraft.com/photos/ph-ho4l8rev40-2.jpg",
"taken_at": "2026-11-13T16:00:00.000Z",
"demo": true
}
Recheck
| atrequiredstring (date-time) | |
| byrequiredPerson | |
| resultrequiredstring | One of: fixed still_open |
| notestring | |
| photosarray of Photo | |
Example
{
"at": "2026-11-13T16:00:00.000Z",
"by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"result": "still_open",
"note": "No visible change",
"photos": []
}
Violation
| idrequiredstring | |
| statusrequiredstring | One of: open resolved |
| locationrequiredLocation | |
| issue_typerequiredstring | One of: landscaping trash exteriorMaintenance fence parking unapprovedChange signage commonAreaDamage other |
| titlerequiredstring | |
| descriptionstring | |
| levelinteger · nullable | 1 = first offence of this issue type at this location. |
| suggested_stagestring · nullable | Advisory |
| cure_bystring (date-time) · nullable | Next re-check date. |
| rulesarray of Rule | |
| photosarray of Photo | |
| observed_atrequiredstring (date-time) | |
| observed_byPerson | |
| approved_atstring (date-time) · nullable | |
| approved_byPerson · nullable | |
| session_idstring · nullable | The drive it was found on. |
| ai_assistedboolean | An AI suggestion was reviewed and approved by a person. |
| ai_confidencenumber · nullable | |
| rechecksrequiredarray of Recheck | |
| resolved_atstring (date-time) · nullable | |
| resolutionstring · nullable | |
Example
{
"id": "f-ho4l8rev40-3",
"status": "open",
"location": {
"kind": "property",
"id": "willow-creek-p02",
"lot_number": "Lot 02",
"address": "103 Willow Creek Dr",
"geo": {
"lat": 30.544895,
"lng": -97.692616
}
},
"issue_type": "landscaping",
"title": "Lawn not maintained",
"description": "Turf about 8 in, weeds in beds.",
"level": 1,
"suggested_stage": "Courtesy notice",
"cure_by": "2026-11-27T16:00:00.000Z",
"rules": [
{
"id": "wce-ccr-7.1",
"document": "CC&Rs",
"section": "7.1",
"title": "Lawn and Landscape Maintenance"
}
],
"photos": [
{
"id": "ph-ho4l8rev40-2",
"url": "https://files.hoacraft.com/photos/ph-ho4l8rev40-2.jpg",
"taken_at": "2026-11-13T16:00:00.000Z",
"demo": true
}
],
"observed_at": "2026-11-13T16:00:00.000Z",
"observed_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"approved_at": "2026-11-13T16:00:00.000Z",
"approved_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"session_id": "sess-ho4l8rev40-0",
"ai_assisted": true,
"ai_confidence": 0.86,
"rechecks": [],
"resolved_at": null,
"resolution": null
}
Rule
| idstring | |
| documentstring | e.g. CC&Rs |
| sectionstring | e.g. 7.1 |
| titlestring | |
Example
{
"id": "wce-ccr-7.1",
"document": "CC&Rs",
"section": "7.1",
"title": "Lawn and Landscape Maintenance"
}
WorkOrder
| idrequiredstring | |
| numberrequiredinteger | Per-community number shown to staff |
| statusrequiredstring | One of: open assigned inProgress completed cancelled |
| locationrequiredLocation | |
| titlerequiredstring | |
| categoryrequiredstring | One of: landscaping irrigation lighting poolAmenity fencingGates signage drainage pavement general |
| priorityrequiredstring | One of: low normal high urgent |
| descriptionstring | |
| vendorobject · nullable | |
| due_datestring (date-time) · nullable | |
| follow_up_datestring (date-time) · nullable | When the inspector plans to check it again. |
| photosarray of Photo | |
| created_atrequiredstring (date-time) | |
| created_byrequiredPerson | |
| ai_assistedboolean | The description was drafted with AI and reviewed by the creator. |
| completed_atstring (date-time) · nullable | |
| completion_notesstring · nullable | |
Example
{
"id": "wo-ho4l8rev40-b",
"number": 106,
"status": "completed",
"location": {
"kind": "common_area",
"id": "wce-ca-pool",
"address": "Pool & Clubhouse",
"geo": {
"lat": 30.544838,
"lng": -97.690914
}
},
"title": "Pool gate latch broken",
"category": "fencingGates",
"priority": "urgent",
"description": "Latch does not catch; gate will not self-close.",
"vendor": {
"id": "v-ssh",
"name": "SSH Gates & Access"
},
"due_date": null,
"follow_up_date": null,
"photos": [],
"created_at": "2026-11-13T16:00:00.000Z",
"created_by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"ai_assisted": false,
"completed_at": "2026-11-13T16:00:00.000Z",
"completion_notes": "Latch and closer replaced, tested"
}
SiteReview
| idrequiredstring | |
| atrequiredstring (date-time) | |
| byrequiredPerson | |
| outcomerequiredstring | The inspector's recommendation. Advisory only. One of: reviewed moreInfoNeeded recommendApproval recommendDenial |
| observationsstring | |
| measurementsstring | |
| rulesarray of Rule | Rules the reviewer checked against. |
| photosarray of Photo | |
| session_idstring · nullable | The drive it was done on. |
Example
{
"id": "sr-ho4l8rev40-i",
"at": "2026-11-13T16:00:00.000Z",
"by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"outcome": "recommendApproval",
"observations": "Old fence runs on the survey line; no easement conflict.",
"measurements": "Proposed height 6 ft, matches neighbours",
"rules": [
{
"id": "wce-adg-3.4",
"document": "Design Guidelines",
"section": "3.4",
"title": "Fences"
}
],
"photos": [],
"session_id": "sess-ho4l8rev40-0"
}
AccDecision
| decisionrequiredstring | One of: approved approvedWithConditions denied |
| decided_atrequiredstring (date-time) | |
| recorded_byPerson | |
| conditionsstring | |
Example
{
"decision": "approvedWithConditions",
"decided_at": "2026-11-13T16:00:00.000Z",
"recorded_by": {
"id": "staff-marcus",
"name": "Marcus Lee"
},
"conditions": "Stain within 60 days to an Earth Palette colour."
}
AccRequest
| idrequiredstring | |
| numberrequiredinteger | |
| statusrequiredstring | One of: submitted siteReviewPending siteReviewed infoRequested approved approvedWithConditions denied |
| locationrequiredLocation | |
| request_typerequiredstring | One of: fence exteriorPaint shed landscaping solar patio roof |
| titlerequiredstring | |
| descriptionstring | |
| applicant_namestring | |
| requested_atstring (date-time) | |
| documentsarray of object | Names of the files attached to the application. The files stay in your system.2 fields| namestring | | | kindstring | One of: plan colorSample survey quote photo |
|
| site_reviewsrequiredarray of SiteReview | |
| decisionAccDecision · nullable | |
Example
{
"id": "acc-wce-201",
"number": 201,
"status": "approvedWithConditions",
"location": {
"kind": "property",
"id": "willow-creek-p07",
"lot_number": "Lot 07",
"address": "113 Willow Creek Dr",
"geo": {
"lat": 30.54713,
"lng": -97.692082
}
},
"request_type": "fence",
"title": "Replace rear and side fence",
"description": "Replace the existing 6 ft fence along rear and left side with new cedar board-on-board, stained Weathered Grey. Same footprint as current fence.",
"applicant_name": "Owner of record",
"requested_at": "2026-11-08T18:00:00.000Z",
"documents": [
{
"name": "Site plan.pdf",
"kind": "plan"
},
{
"name": "Contractor quote.pdf",
"kind": "quote"
}
],
"site_reviews": [
{
"id": "sr-ho4l8rev40-i",
"at": "2026-11-13T16:00:00.000Z",
"by": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"outcome": "recommendApproval",
"observations": "Old fence runs on the survey line; no easement conflict.",
"measurements": "Proposed height 6 ft, matches neighbours",
"rules": [
{
"id": "wce-adg-3.4",
"document": "Design Guidelines",
"section": "3.4",
"title": "Fences"
}
],
"photos": [],
"session_id": "sess-ho4l8rev40-0"
}
],
"decision": {
"decision": "approvedWithConditions",
"decided_at": "2026-11-13T16:00:00.000Z",
"recorded_by": {
"id": "staff-marcus",
"name": "Marcus Lee"
},
"conditions": "Stain within 60 days to an Earth Palette colour."
}
}
Drive
| idrequiredstring | |
| titlestring | |
| started_atrequiredstring (date-time) | |
| ended_atstring (date-time) · nullable | |
| inspectorrequiredPerson | |
| stopsrequiredobject | 3 fields| totalinteger | | | completedinteger | | | skippedarray of object | 2 fields| addressstring | | | reasonstring | |
|
|
| violations_createdarray of string | |
| rechecksarray of object | 2 fields| violation_idstring | | | resultstring | One of: fixed still_open |
|
Example
{
"id": "sess-ho4l8rev40-0",
"title": "Open items: Nov 13",
"started_at": "2026-11-13T16:00:00.000Z",
"ended_at": "2026-11-13T16:00:00.000Z",
"inspector": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"stops": {
"total": 7,
"completed": 0,
"skipped": []
},
"violations_created": [
"f-ho4l8rev40-3"
],
"rechecks": [
{
"violation_id": "f-ho4l8rev40-3",
"result": "fixed"
},
{
"violation_id": "f-wce-3",
"result": "still_open"
}
]
}
WebhookEndpoint
| idstring | |
| urlstring (uri) | |
| eventsarray of EventType | |
| enabledboolean | |
| created_atstring (date-time) | |
Error
| coderequiredstring | |
| messagerequiredstring | |
| detailsobject | |