API Overview

The HOAOS API allows you to programmatically access and manage your association data. This RESTful API uses JSON for all requests and responses.

Base URL

All API requests should be made to:

https://api.hoaos.app/v1

For tenant-specific APIs, use your subdomain:

https://your-association.hoaos.app/api

Authentication

The API uses bearer token authentication. Include your API key in the Authorization header:

Authorization: Bearer your_api_key_here

You can generate API keys in your admin dashboard under Settings → API Keys.

Response Format

All successful responses return JSON with this structure:

{
  "success": true,
  "data": { ... }
}

Error responses include an error message:

{
  "success": false,
  "error": "Error message here"
}

Rate Limiting

API requests are rate limited to prevent abuse:

Plan	Rate Limit
Starter	100 requests/minute
Professional	500 requests/minute
Enterprise	2,000 requests/minute

Rate limit headers are included in all responses:

X-RateLimit-Limit: 500
X-RateLimit-Remaining: 499
X-RateLimit-Reset: 1609459200

Available Endpoints

Members

• GET /members - List all members
• GET /members/:id - Get a specific member
• POST /members - Create a new member
• PUT /members/:id - Update a member
• DELETE /members/:id - Remove a member

Units

• GET /units - List all units
• GET /units/:id - Get a specific unit
• POST /units - Create a new unit
• PUT /units/:id - Update a unit

Invoices

• GET /invoices - List all invoices
• GET /invoices/:id - Get a specific invoice
• POST /invoices - Create a new invoice
• POST /invoices/:id/send - Send an invoice

Payments

• GET /payments - List all payments
• GET /payments/:id - Get a specific payment

Board Records

• GET /board-records - List board records
• GET /board-records/:id - Get a specific record
• POST /board-records - Create a new record

Webhooks

HOAOS can send webhook notifications when events occur. See the Webhooks documentation for details.

SDKs & Libraries

Official SDKs are coming soon. In the meantime, you can use any HTTP client to interact with the API.

Need Help?

If you have questions about the API, contact us at [email protected].