API

Everything the platform does, over REST

One base URL, one header, JSON everywhere. Search businesses and people across Australia and New Zealand, inspect profiles, unlock contacts and export records - from your own code.

First request

A search in one call

Authenticate with a single x-api-key header. No OAuth dance, no signing. The example searches businesses in New South Wales and gets matching profiles straight back.

  • Same engine as the app. Anything you can find in the dashboard, you can find here.
  • Filter endpoints included. Pull the available values for any field to build precise queries.
  • Exports over API. Request a CSV the same way the app does, then download it when it is ready.
# businesses in NSW
curl -X GET "https://api.knowfirst.ai/v1/business/list?state=NSW" \
  -H "x-api-key: $KF_API_KEY"
// businesses in NSW
const res = await fetch("https://api.knowfirst.ai/v1/business/list?state=NSW", {
  headers: { "x-api-key": process.env.KF_API_KEY },
});
const data = await res.json();
# businesses in NSW
import os, requests

res = requests.get(
    "https://api.knowfirst.ai/v1/business/list?state=NSW",
    headers={"x-api-key": os.environ["KF_API_KEY"]},
)
data = res.json()
# response (truncated)
{
  "total_results": 412098,
  "results": [
    { "name": "Acme Pty Ltd",
      "abn": "12 345 678 901",
      "state": "NSW",
      "anzsic": "E",
      "employees": "20-50" }
  ],
  "next_token": "..."
}
Endpoints

The core surface

All endpoints are relative to https://api.knowfirst.ai/v1 and speak JSON.

EndpointWhat it does
GET/business/listSearch companies across AU and NZ. Filter by name, industry (ANZSIC), location, size, registration details and more; paginate through results.
GET/person/listSearch people - by name, role, seniority, company or location - with the same filter style as business search.
GET/business/list/fields/{field}Discover the values a filter accepts (industries, states, size bands and friends), so queries are built from real options, not guesses.
GET/person/list/estimatePrice an export before committing: how many records match and what the export would cost in credits.
GET/person/list/exportRequest a CSV export of a person search with your chosen fields. Poll its status, then download - charged once on first download.
GET/user/exports/personList the person exports you have requested, with status and download links - the same list the Exports view shows.

One key, one account

Your account has one API key: reveal it to copy it, generate one if you have none, and regenerate it any time - the old key stops working immediately.

Billed in credits

Data requests like searches, profile views and exports spend credits from the same balance as the platform, exactly like the dashboard. Managing your lists and saved searches is free.

Plain REST

No SDK required - if your stack can send an HTTP request with a header, it can talk to KnowFirst. Curl it from a terminal to see for yourself.

Build on the whole database

Create a free account, reveal your API key and make your first call in under a minute.