Versioning

The 3Common REST API is versioned via the URL path. The current version is v1, served from https://api.3common.com/v1/.

What counts as non-breaking

The following changes are released to v1 without a major-version bump:

• Adding new endpoints, resources, or tags.
• Adding optional request parameters.
• Adding new fields to a response body.
• Adding new error codes.
• Performance and stability improvements.

Build defensively. Your integration should ignore unknown response fields rather than fail on them.

What counts as breaking

These changes will land on a new major version (v2, etc.) rather than modifying v1:

• Removing or renaming endpoints.
• Removing or renaming response fields.
• Changing the type of a response field.
• Changing required-vs-optional on request parameters.
• Changing authentication semantics.

When v2 ships, v1 will continue to serve traffic. Deprecation timelines will be announced through email and the help center before any version is turned off.

Tracking changes

The OpenAPI document is the source of truth: api.3common.com/docs/json.