Skip to main content

API Versioning

API-Version Header​

The API-Version header must be set for all API requests. The current version is 2021-11-21.

curl https://api.agaveapi.com/link/company \
     --header 'API-Version: 2021-11-21' \
     --header 'Client-Id: 53b2b9cb-9828-5197-8fe8-ed91f623b135' \
     --header 'Client-Secret: FwRIpg6ezHuGBOMFxT30suIbkkHtAq67BQWpLTeN' \
     --header 'Account-Token: 2FwppFrITHMpt3F7vfNQmJw7xYymcQ3tdXw6Uk0n'

If you do not include this header, you will receive a 401 - Unauthorized response:

{"message": "Invalid API-Version header"}

Backward-Compatible API Changes​

We are constantly adding new Integrations and endpoints. We expect most of these changes to be fully backward-compatible and to introduce them without releasing a new API-Version.

Examples of backward-compatible changes include:

  • Adding new API endpoints
  • Adding new optional request parameters to existing endpoints
  • Adding new properties to existing responses
  • Adding new values to existing ENUM properties
  • Changing the order of properties in existing responses
  • Changing the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings
  • Adding new error types

Non-Backward-Compatible API Changes​

When we need to introduce breaking changes, we will release a new version of the API to ensure existing clients are not impacted.