API Documentation

Reference for the HawkLeads REST API. API access requires a Pro or Agency plan.

Overview

The HawkLeads API is a REST API that returns JSON responses. All requests must be made over HTTPS. The base URL for all API endpoints is:

https://hawkleads.io/api/v1

Content Type

All POST, PUT, and PATCH requests must include a Content-Type: application/json header. Request bodies must be valid JSON.

Versioning

The API is versioned in the URL path (/api/v1/). Breaking changes will be introduced under a new version prefix. Non-breaking additions (new fields, new endpoints) may be added without a version bump.

Available Endpoints

GET/POST /api/v1/leads

GET/PATCH /api/v1/leads/:id

GET/POST /api/v1/widgets

GET/PATCH/DELETE /api/v1/widgets/:id

GET/PUT /api/v1/widgets/:id/flow

GET /api/v1/analytics

POST /api/v1/submit

POST/PATCH /api/v1/account