Skip to main content

Versioning

The public API is versioned in the URL path. All current endpoints live under /v1:

https://api.abcsalesbot.com/v1/...

Compatibility​

Within a major version (v1) we aim to make only backwards-compatible changes, such as:

  • Adding new endpoints.
  • Adding new optional request fields.
  • Adding new fields to responses.

Treat the API defensively: ignore response fields you don't recognize, and don't depend on the order of items in a list or on undocumented behavior.

Breaking changes (removing or renaming fields, changing types, changing required inputs) would be introduced under a new major version (/v2), not within v1. Notable changes are recorded in the Changelog.

OpenAPI spec​

The full machine-readable specification is published and kept in sync with the live API. You can download the OpenAPI spec and generate clients from it.