Husbandry.Pro API

Changelog

Breaking changes to documented, non-experimental endpoints get at least 90 days' notice and a Sunset header. Additive changes may ship at any time.

API v1 documented surface

Version 1.0.0 of the Husbandry.Pro API is the documented v1 surface.

Base URL is https://next.husbandry.pro. Paths are under /api/v1. The classic husbandry.pro domain is a separate older system and does not serve this API.

Open to integrators on the Breeder plan and above, and to accounts on the live-test allowlist while GET /status reports limited. The docs stay public either way.

What v1 includes:

  • Account (GET /me)
  • Animals, read and write, plus this account's species list
  • Activities, read and write, plus activity types
  • Breeding records and clutches (read)
  • Medical conditions (read)
  • Contacts and invoices (read; these scopes carry customer personal data)
  • Documents (list metadata; upload and download are not in v1)
  • Environment list, metrics, and stored readings (read)
  • Sensor devices, JSON ingest, constrained-firmware ping (GET and POST), and

headless pairing

  • Webhook endpoints (create, pause, retarget, delete)
  • Species reference library
  • Status and the OpenAPI document at /api/v1/openapi.json

Writes that are not in v1, and return 405 if you call them: breeding, medical, contacts, sales, document upload, and creating environments or zones. Those scopes can still be granted so a key keeps working when the endpoints land.

Authentication is a bearer token (hpk_ personal access token or hpd_ device key). X-API-Key is accepted too. Device keys can only push readings and read their own device configuration.