Current version: v2
Every endpoint documented in the API reference lives under/v2/.... This is the version to build against — info.description in the spec reads:
API v2. Use these endpoints for new integrations.v2 is stable. Backward-compatible changes (new optional fields on responses, new endpoints, new optional query parameters) ship without a version bump. Breaking changes would ship as
/v3/... alongside /v2/....
What counts as a breaking change
Breaking, requires a version bump:- Removing or renaming an endpoint, query parameter, or response field.
- Changing the type of an existing response field.
- Tightening validation on a parameter that previously accepted broader input.
- Changing the JSON error envelope.
- New endpoints.
- New optional response fields.
- New optional query parameters or body fields.
- Bug fixes that align actual behaviour with documented behaviour.
Legacy endpoints
A small set of older routes is still served for historical integrations and is exposed via a separate spec at/api/documentation/spec/legacy. These are not documented here, are not maintained, and may be retired without notice. Migrate to v2 if you’re still using them.
Discovering changes
- Watch the Changelog for material changes.
- The full OpenAPI spec is at
/api/documentation/spec/v2— diff it between deploys if you want a precise record. - For breaking-change notice timelines, see the changelog or email support@thedatacity.com.