API v1
HousingStreet public API v1 overview — auth, tenant scope, and where to find live routes.
Goal
Authenticate and call HousingStreet API v1 endpoints from your own tools or integrations.
Base URL
Use your environment’s API host:
- Production:
https://api.housingstreet.com - Local development:
http://localhost:3002(api-core)
All authenticated business routes live under /api/... on that host.
Authentication
- Create an API key in platform admin (Enterprise: API & webhooks settings) when your plan includes API access.
- Send
Authorization: Bearer <token>on every request. - Never expose API keys in public websites, mobile apps, or browser JavaScript.
Tenant isolation is enforced server-side — your key only sees your tenant’s data.
Public marketing endpoints (no auth)
These power housingstreet.com content and are safe to read without a tenant key:
| Method | Path | Purpose |
|---|---|---|
| GET | /api/public/platform/blog | Published platform blog posts |
| GET | /api/public/platform/blog/:slug | Single blog post |
| GET | /api/public/platform/pages | Published CMS landing pages |
| GET | /api/public/platform/pages/:slug | Single CMS page |
Query params for blog list: page, limit (max 100), category, tag, search.
Tenant product APIs
Authenticated routes cover properties, leads/clients, media, billing, themes, and more. Exact paths evolve with the product — use platform admin → API / webhooks for keys and current webhook events.
Errors
JSON errors follow { "success": false, "error": string, "code"?: string }. Treat non-2xx as failures; respect rate-limit headers when present.
Next
A full OpenAPI reference is on the roadmap. Until then, this overview plus Help Center guides are the source of truth.
- Roadmap: /features#roadmap
- Help: API keys and webhooks