Follow
Specifying an API Version in Your Integrations

All Workfront URIs are required to reference a specific version of the API after the “attask/api” portion of the URI. The following example calls Version 7.0:

attask/api/v7.0/<objectName>/<objectId>

Please ensure all your integrations call currently-supported Workfront APIs.

Release and Deprecation Schedule of Workfront APIs

New versions of the API are released on a biannual basis--every six to eight months. Each version is supported for three years after its release date, with an additional year in a deprecated state where the version is available but not supported.

For more information on the release cadence and deprecation schedule of Workfront APIs, see "API Version Release and Deprecation Schedule."

Workfront deprecated the Default Version of the API as of July 2017. This means Workfront no longer designates a specific version of the API to be the Default Version. All future API URIs must specify a version of the API in order to be valid.

IMPORTANT  Any integrations using the Default API version must be updated to call a specific supported API version by July 1, 2018.

Determining the API Version You Are Using

You can determine the version of the API you are using by checking the URI of an HTTP request sent to the Workfront API. The following example shows a Workfront request URI that specifies Version 7 of the API:

https://<domainname>.my.workfront.com/attask/api/v7.0/proj/4c7c08b20000002de5ca1ebc19edf2d5

If a URI does not specify a version, then it is using the Default Version of the API, as shown in the following example:

https://<domainname>.my.workfront.com/attask/api/proj/4c7c08b20000002de5ca1ebc19edf2d5

IMPORTANT Integrations that do not specify a version of the API in the URI are automatically routed to the Default Version of the API and will fail to work after July 1, 2018. 

Updating Integrations to Use Supported API Versions

As you build or maintain Workfront integrations you should include a method for dynamically updating the API version and other properties subject to change (such as your API key).

To make updating integrations more efficient, you should consider the following suggestions for recording integration values: 

  • Store values subject to future changes in a properties file you keep updated
  • Create a web service to manage properties in real time
  • Store property values in a data store that your application can read

Designing your Workfront integrations with this in mind alleviates the need for extensive development work when those values inevitably change.