Skip to content
KnockDevelopers

Versioning & changelog

How the Knock API is versioned, which changes are backward compatible, and what changed when.

Chat with a Developer

How versioning works

The API version is part of the path. Every endpoint in this documentation is version 1:

Versioned paths
POST /v1/enrichment-requests/people
POST /v1/enrichment-requests/companies
GET  /v1/enrichment-requests/{enrichRequestId}
GET  /v1/chats
GET  /v1/chats/{contactId}/messages
GET  /v1/meetings
GET  /resources/whoami/v1

Within a version, Knock only makes backward-compatible changes, so code written against v1 keeps working. A change that could break an existing integration ships as a new version, such as /v2/..., and v1 keeps working alongside it.

Backward-compatible changes

Knock may make these changes to v1 at any time, without a new version:

  • Adding new endpoints.
  • Adding optional request fields.
  • Adding new fields to response objects, including person and company results.
  • Adding new error codes for new failure cases.
  • Adding new response headers.
  • Changing the order of fields in a response.
  • Returning new values in free-form text fields, such as industry, size or lastFunding.
  • Changing human-readable error messages in errors.

Build your integration to tolerate them:

  • Ignore response fields you don't recognize instead of failing on them.
  • Branch on code and HTTP status, never on the text of an error message.
  • Handle an unfamiliar error code by its HTTP status (see Errors).
  • Treat the "typical values" listed for result fields as examples, not a closed list.

Breaking changes

These changes only ship in a new version:

  • Removing or renaming an endpoint, a request field or a response field.
  • Changing a field's type, or making a field nullable that wasn't.
  • Making an optional request field required, or tightening validation of existing input.
  • Changing the meaning of a request or item status.
  • Changing the authentication method.

When a new version ships, Knock announces it in this changelog and gives notice before an older version is retired.

OpenAPI specification

The API reference is generated from the API's OpenAPI document. You can download it from /openapi.json to generate a client or import the API into tools such as Postman.

Changelog

2026-10-20

Chats and meetings. Read your chats and meetings with a Viewer key:

Enrichment API v1. First public release of the Knock API:

Chat with a Developer

On this page