API Overview
For documentation on specific API endpoints, please use the API Reference tab. Within the API Library, you will find:
- Endpoint descriptions (purpose, inputs, outputs)
- Supported HTTP methods
- Validation rules and required fields
- Example cURL commands
- JSON schemas for both requests and responses
- Error cases and troubleshooting guidance for each route
Webhooks
Many services performed through the Property Insight API are asynchronous. Rather than requiring your system to poll repeatedly for status updates, Property Insight uses webhooks to notify you automatically when certain events occur.
- To receive webhook notifications:
- Create an HTTPS endpoint on your server capable of receiving POST requests.
- Ensure the endpoint accepts and parses JSON in the request body.
- Implement verification logic if you need to confirm events originate from Property Insight (e.g., HMAC signature verification, IP allowlist—details vary per environment).
- Respond with a 200 OK status to acknowledge successful receipt.
- Provide your webhook URL to Property Insight via your account configuration or onboarding form.
If the receiving server returns a non‑200 HTTP response, Property Insight may retry sending the webhook based on its internal retry schedule. Developers should ensure the listener endpoint is highly available, Idempotent (safe to call multiple times), and capable of logging incoming webhook events for audit and debugging
API protocols and headers
The Property Insight API follows REST principles and uses JSON over HTTP. The API uses standard HTTP verbs, authentication, and status codes. All Property Insight API endpoints require a client_id and secret.
Authentication
Our APIs use OAuth 2.0 client credentials for secure authentication. These credentials should be stored securely - do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, etc.
Step 1: Request an Access Token: Your application will first request an access token from our Authorization Server using client credentials grant type. You'll provide your Client ID and Client Secret.
Step 2: Call the API Using the Token: Include the token in the Authorization header for every API request.
Step 3: Token Validation: Each request that reaches our API Gateway includes your bearer token.
If you have any questions about your keys, please contact [email protected]
Environments
Property Insight provides two separate environments: Test Production Items created in one environment cannot be transferred to the other. The Test environment is intended exclusively for testing and uses sandbox datasets.
API Versioning
More to come.
Troubleshooting
Property Insight uses well‑established HTTP status codes to signal success, errors, or partial failures:
- 200/201 – Successful request
- 400 – Invalid request payload or missing fields
- 401/403 – Authentication/authorization issues
- 404 – Resource not found
- 409 – Conflicts
- 500 – Internal system error Detailed error messages are returned in the response body to assist with debugging.