Skip to content

API — Quickstart

Everything you can do in the app, you can do over a simple HTTP API. All endpoints live under /v1 and return JSON.

1. Get an API key

In the app, open Account → API keys and create one (see Teams & access). Copy the secret immediately — it’s shown only once.

2. Find your base URL

  • Hosted: https://app.bizquery.dev
  • Self‑hosted: your own BizQuery host.

The API is then at <base>/v1.

3. Authenticate

Send the key as a Bearer token on every request:

Terminal window
export BQP_BASE="https://app.bizquery.dev"
export BQP_KEY="your-api-key"
curl "$BQP_BASE/v1/personas" \
-H "Authorization: Bearer $BQP_KEY"

A 200 with a JSON array means you’re in. A 401 means the key is missing or wrong.

Explore the full reference

Browse the complete, interactive API reference here: API reference — every endpoint with its exact request and response shapes, generated from the OpenAPI spec.

Your own BizQuery host also serves a live, authenticated Swagger console at /docs for trying calls against your own data.