Skip to content
SMBcrmSMBcrm Developers

Versioning & Stability

The SMBcrm REST API is designed to stay stable under you. Pin one header, parse responses tolerantly, and an integration you write today keeps working as the product grows.

Pin the Version header

Section titled “Pin the Version header”

Every request carries a Version header:

Version: v3

v3 is the current API version, and it’s what this documentation targets. Send Version: v3 on every request. Omitting the header returns an error (version header was not found).

The API also recognizes older date-based versions (for example 2021-07-28) so existing integrations keep working, but new endpoints and enhancements are added to v3 only. Build new work against v3. See Base URL & Headers for the full header list and a complete request example.

What changes, and what doesn’t

Section titled “What changes, and what doesn’t”

The API grows without breaking existing integrations:

  • New fields get added. Response objects may gain fields that aren’t shown here yet. Read the fields you need by name and ignore the rest, rather than validating against a closed schema.
  • Documented shapes hold for a given version. The paths, methods, and payloads on each reference page are the contract for v3.
  • Test against the documented shapes, not against undocumented behavior you happen to observe.
Section titled “Related”