API reference
Documents
Endpoints for listing and retrieving HOA documents.
List documents
GET /v1/documentsReturns a paginated list of documents.
Query parameters
| Parameter | Type | Description |
|---|---|---|
county | string | Filter by county name |
type | string | Filter by document type (ccr, bylaws, amendment, easement) |
status | string | Filter by processing status |
page | integer | Page number (default: 1) |
per_page | integer | Items per page (default: 20, max: 100) |
Response
{
"data": [
{
"id": "doc_abc123",
"document_type": "ccr",
"document_category": "governing",
"status": "completed",
"county": "Franklin",
"recording_date": "2005-03-15",
"page_count": 45,
"fact_count": 23,
"created_at": "2024-01-10T08:00:00Z"
}
],
"meta": {
"total": 150,
"page": 1,
"per_page": 20
}
}Get document
GET /v1/documents/{id}Returns a single document by ID.
Response
{
"data": {
"id": "doc_abc123",
"document_type": "ccr",
"document_category": "governing",
"status": "completed",
"county": "Franklin",
"recording_date": "2005-03-15",
"instrument_number": "2005-0315001",
"page_count": 45,
"fact_count": 23,
"type_metadata": {
"hoa_name": "Desert Ridge Community Association",
"subdivision": "Desert Ridge Phase 2"
},
"created_at": "2024-01-10T08:00:00Z",
"updated_at": "2024-01-10T09:30:00Z"
}
}Get document restrictions
GET /v1/documents/{id}/restrictionsReturns all restriction facts extracted from a specific document.
Response
{
"data": [
{
"id": "fact_def456",
"fact_type": "rental_restriction",
"fact_value": {
"restriction_type": "minimum_lease_term",
"minimum_months": 12
},
"confidence": 0.94,
"citation": {
"page": 14,
"section": "Article VII, Section 3"
}
}
]
}