Versioning
The API version is part of the URL. The current authenticated resource API is
/v1, and the account-scoped public API is /p/v1.
The API does not currently select a resource version from a request header.
Changing an Accept header therefore does not opt a request into a different
API version.
Compatible changes
Seção intitulada “Compatible changes”Clients should tolerate compatible additions, including:
- new attributes or relationships in a resource;
- new members in response
metaobjects; - new optional request parameters;
- new resource and event types;
- new enum values when the resource page describes the field as extensible.
Ignore response members your integration does not use and avoid exhaustive matching on undocumented values.
Breaking changes
Seção intitulada “Breaking changes”A future API with incompatible request or response behavior would use a new versioned path. Resource pages document exceptions where a legacy operation does not yet follow the current conventions.
Authentication and external integration approval apply across versioned surfaces unless a future version explicitly documents different requirements.
