Developers

HOVER API

Book jobs, sync schedules, and pull operational data straight into your own tools. Authenticate with an API key and call resource endpoints over HTTPS.

Base URL: https://api.hover.example/v1Version: 2026-06-01

Endpoints marked Live hit real data. Preview endpoints return representative sample data from the local test environment so you can build against them today. Generate a key under Authentication, then open any endpoint and hit Run.

POST/v1/keysLive

Create API Key

Authenticate with your HOVER email and password to mint (or rotate) an API key. Only partner admins and HOVER staff can hold keys. The key is shown in full once — store it securely.

Scope: company_admin, owner_admin

Endpoint

HTTP

POST https://api.hover.example/v1/keys

Body parameters

`email`required string	The email address of your HOVER account. Example: `admin@legacysolar.local`
`password`required string	Your account password.

Live test

API key console

Sign in with a partner admin or HOVER staff account to mint a test key, then call a real endpoint with it. Keys work against this local environment only.

Example request

cURL

curl "https://api.hover.example/v1/keys" \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "admin@legacysolar.local",
  "password": ""
}'

Example response

200 · application/json

{
  "apiKey": "hvr_test_8f2c…a91b",
  "createdAt": "2026-06-25T12:00:00.000Z",
  "account": {
    "id": "usr_123",
    "name": "Legacy Solar Admin",
    "role": "company_admin",
    "companyId": "co_legacy_solar"
  }
}