English
API
Last updated 1 August 2026
Two endpoints, read only. They return what the pipeline found for your workspace: the companies it read, and the ones that cleared every gate. Everything the dashboard shows on those two screens is available here, in JSON, for the same workspace and no other.
Authentication
Create a key in the dashboard under Settings. It is shown once, because only a hash of it is stored, so there is no screen that can reveal it again later. Send it as a bearer token.
curl https://knockwire.com/api/reads \
-H "Authorization: Bearer kw_live_..."A request with no key, a malformed header or a revoked key gets 401 with a JSON body explaining which. A key reads every company and every refusal in its workspace, so it is worth the same care as a password. Revoking one in Settings takes effect on the next request.
Endpoints
- GET /api/reads Every company the pipeline looked at, newest first. Filter with outcome=refuse or outcome=knock. Defaults to refusals, because the refusals are the part worth reading. limit defaults to 100 and is clamped to 500.
- GET /api/prospects The companies that cleared all four gates, with their score and the rationale behind it.
There is no tenant parameter. The key decides whose data comes back, and a request that carries tenant= is refused with a 400 rather than quietly ignored.
What this API does not do yet
Stated here so nobody discovers it halfway through an integration.
- No writes. There is no endpoint that accepts a list of companies. Discovery reads its own sources.
- No sending. Nothing in this API can approve or deliver a message. Approval is a person in the dashboard, and that is a product decision rather than a missing feature.
- No version prefix. Paths are unversioned while the shape is still moving. When that changes it will be announced on the changelog.
- No published rate limit. There is no per-key throttle today. Be reasonable, and expect one to appear before it is needed rather than after.