HomeBase API

The HomeBase API provides programmatic access to your entire managed security and operations platform — tenants, alerts, devices, identity, and compliance — all through a single REST interface.

Base URL

https://api.hldgroup.org/v1

Core resources

• Tenants — client organisations managed under your HomeBase instance. Each tenant has its own isolated data, configuration, and user set.
• Alerts — security events detected across your monitored surface. Includes severity, source, affected assets, and status.
• Devices — enrolled endpoints, servers, and network devices under HomeBase management.
• Identity — user accounts, roles, access records, and risk scores from integrated identity providers.
• Compliance — framework posture, control evidence, and audit-ready reports.

Pagination

All list endpoints are paginated using cursor-based pagination. Pass page and per_page as query parameters.

GET /v1/tenants?page=2&per_page=50

{
  "data": [...],
  "pagination": {
    "page": 2,
    "per_page": 50,
    "total": 143,
    "has_more": true,
    "next_cursor": "cur_01hxyz"
  }
}

Filtering

Most list endpoints support filter[field]=value query syntax.

# Filter alerts by severity
GET /v1/alerts?filter[severity]=critical&filter[status]=open

# Filter devices by tenant
GET /v1/devices?filter[tenant_id]=ten_01hxyz

Timestamps

All timestamps are returned in ISO 8601 format in UTC. When filtering by time ranges, use filter[created_after] and filter[created_before] with ISO 8601 values.