API & Webhooks

Complete documentation for integrating with PropertyFlow HQ.

Authentication

All API requests require authentication using an API key. Include your key in the Authorization header:

Authorization: Bearer pk_live_your_api_key_here

API Key Scopes

Scope	Description
`properties:read`	Read property information
`properties:write`	Create and update properties
`units:read`	Read unit information
`units:write`	Create and update units
`tenants:read`	Read tenant information
`leases:read`	Read lease information
`leases:write`	Create and manage leases
`payments:read`	Read payment history
`maintenance:read`	Read maintenance tickets
`maintenance:write`	Create and update tickets

Rate Limiting

API requests are rate limited to 1,000 requests per hour. Rate limit headers are included in every response:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1704067200

Endpoints

Properties

Units

Leases

Payments

Maintenance

Code Examples

# List properties
curl -X GET "https://your-domain.com/api/v1/properties" \
  -H "Authorization: Bearer pk_live_your_api_key"

# Create a maintenance ticket
curl -X POST "https://your-domain.com/api/v1/maintenance" \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Broken AC", "description": "Not working"}'