---
title: API v1
description: "HousingStreet public API v1 overview — auth, tenant scope, and where to find live routes."
canonical_url: https://housingstreet.com/docs/api/v1
md_url: https://housingstreet.com/docs/api/v1.md
last_updated: 2026-07-20
status: ga
relatedRoutes: []
---

## Goal [#goal]

Authenticate and call HousingStreet API v1 endpoints from your own tools or integrations.

## Base URL [#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 [#authentication]

1. Create an API key in platform admin (Enterprise: API & webhooks settings) when your plan includes API access.
2. Send `Authorization: Bearer <token>` on every request.
3. 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) [#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 [#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 [#errors]

JSON errors follow `{ "success": false, "error": string, "code"?: string }`. Treat non-2xx as failures; respect rate-limit headers when present.

## Next [#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](/features#roadmap)
* Help: [API keys and webhooks](/help/enterprise/api-and-webhooks)