The Site API is implemented by integration partners on their own infrastructure. Once implemented, Hauler Hero calls the partner's endpoint to retrieve and synchronize disposal sites, kiosks, and materials for a given hauler.
See the Data Model page for the entity hierarchy and relationship rules.
You'll build and host this API on your own infrastructure, then share the URL and credentials with Hauler Hero.
- A public URL where the endpoint is reachable (e.g.,
https://api.yourcompany.com/scale-hero/v1/sites) - An
API-KEYthat you issue to Hauler Hero. See Authentication.
- You implement
GET /scale-hero/v1/siteson your infrastructure, following this specification. - You expose it at a public URL and issue an
API-KEYto Hauler Hero. - Hauler Hero calls
GET /scale-hero/v1/sites?haulerId={haulerId}with theAPI-KEYheader. - You return all active sites, kiosks, and materials for that hauler.
- Hauler Hero maps and stores the data for ongoing synchronization.
Your implementation must:
- Accept a
haulerIdquery parameter (UUID) identifying which hauler's data to return. - Return all active sites, kiosks, and materials for that hauler.
- Include accurate
updatedAttimestamps (ISO 8601) on every entity so Hauler Hero can track changes. - Follow the required/optional fields defined in the Schemas section of the Site API reference.
- Authenticate requests via the
API-KEYheader.
GET /scale-hero/v1/sites?haulerId={haulerId}
| Parameter | In | Required | Notes |
|---|---|---|---|
haulerId | query | Yes | UUID identifying the hauler |
API-KEY | header | Yes | The API key you issued to Hauler Hero |
See the Schemas section of the Site API reference for the exact GetSitesResponse shape you must return.
| Code | Error code | Meaning | When your implementation should return this |
|---|---|---|---|
200 | — | Data returned successfully | Normal success with sites, kiosks, and materials arrays |
400 | INVALID_PAYLOAD | haulerId missing or malformed | The haulerId query parameter is absent or not a valid UUID |
401 | UNAUTHORIZED | API key invalid or missing | The API-KEY header is missing or doesn't match what you issued |
404 | NOT_FOUND | Hauler not found | No data exists in your system for the given haulerId |
500 | INTERNAL_ERROR | Unexpected error | Your system hit an unexpected error; log the incident for investigation |
- Integration questions: integrations@haulerhero.com
- API support: api-support@haulerhero.com