All documentation
ReferenceReference

API Reference

A concise reference for the supported public v1 endpoints.

1

Endpoints

The current public v1 surface contains the following supported integration endpoints.

  • GET /api/v1/config — retrieve public company configuration.
  • POST /api/v1/sourcing/price — retrieve sourcing and market-price options.
  • POST /api/v1/quotes/generate — generate a quote draft from text.
  • POST /api/v1/leads/request — request coverage for a city and trade.
2

Price sourcing

Protected by X-API-Key. Query is required; industry and location are optional.

http
POST /api/v1/sourcing/price

{
  "query": "20 sheets 3/4 inch exterior plywood",
  "industry": "construction",
  "location": "Halifax"
}
3

Response conventions

Successful responses are JSON. Validation errors use 422, authentication errors use 401, allowance errors use 429, and unexpected server failures use 500.

4

Versioning

Integrate only with /api/v1 routes documented here. Dashboard and internal /api routes are not part of the public compatibility contract.