Quick start

Make your first authenticated API request to HLD in under 5 minutes. This guide walks through obtaining credentials, making a call, and understanding the response shape.

1. Get your API key

Log in to HomeBase, navigate to Settings → Developer → API Keys, and create a new key. Give it a descriptive name (e.g. my-integration-prod) and select the scopes your integration needs.

Warning:API keys are shown once at creation time. Store them in a secrets manager — never in source control.

2. Make a request

All requests are authenticated with a Bearer token in the Authorization header.

bash

curl https://api.hldgroup.org/v1/tenants \
  -H "Authorization: Bearer hld_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

3. Understand the response

All responses are JSON. Successful responses include a data field. Paginated collections include a pagination object.

json

{
  "data": [
    {
      "id": "ten_01hxyz",
      "name": "Acme Corp",
      "status": "active",
      "region": "ap-southeast-2",
      "created_at": "2025-01-15T09:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 1,
    "has_more": false
  }
}

4. Handle errors

Errors follow a consistent shape across all endpoints. Always check the error.code field to handle specific failure modes programmatically.

json

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or expired API key.",
    "request_id": "req_01hxyz"
  }
}

SDKs

Native SDKs are in active development. In the meantime, any HTTP client works — the API is fully REST-compatible.

Node.js / TypeScript — coming Q3 2025
Python — coming Q3 2025
Go — planned Q4 2025

Authentication HomeBase API