---
title: "Interactive API reference"
section: "Developer Platform"
canonical_url: "https://support.buildwithhq.com/api/interactive-api-reference.html"
reviewed_at: "2026-09-14"
authority: Official
---

# Interactive API reference

Search and inspect every public BuildWithHQ operation from the current generated OpenAPI contract.

## In brief

- **Contract:** 1.0.0-developer-platform
- **Paths:** 286
- **Operations:** 358
- **Developer Kit:** 1.20.28

This reference reads the same public OpenAPI document used to package Developer Kit 1.20.28. Filter by method, tag, path, summary or operation ID, expand an operation to inspect its inputs and responses, then copy a starter cURL command for your trusted server.

[OpenAPI JSON](../openapi/buildwithhq.json) [OpenAPI YAML](../openapi/buildwithhq.yaml) [Contract manifest and checksums](../openapi/manifest.json) [Developer Kit 1.20.28](../downloads/BuildWithHQ-API43-Developer-Kit-1.20.28.zip)

Search operations MethodAll methods TagAll tags

Loading the current public contract...

JavaScript is required for filtering this reference. The complete [JSON](../openapi/buildwithhq.json)  and [YAML](../openapi/buildwithhq.yaml)  contracts remain directly available.

## Use credentials only on a trusted server

The copied command uses an environment-variable placeholder. Keep app credentials and delegated tokens out of browser code. The API still derives tenant, account, user, role and location scope from verified server identity and applies record-level authorization.

## Pin integrations to a version

The stable URLs above always resolve to the current contract. For a reproducible build, use the versioned URLs in the contract manifest or the exact OpenAPI files inside Developer Kit 1.20.28.

---

Capability review: 2026-09-14. [View the canonical guide](https://support.buildwithhq.com/api/interactive-api-reference.html).