API Versioning

Core API is versioned to allow for integrators to have access to a continuously evolving API. Changes between versions are denoted in the API Change Log. You are able to choose the version you would like to use by setting the timestamp in the URL of your API call.

Routing to different versions#

The following URL structure will serve 2022-08 or 2022-04 endpoints as specified in the {version}:

/api/{version}/route

For backwards compatibility, the following URL structure will continue to serve 2022-04 endpoints:

tulip_api/v2/route

Selecting the version via the API request#

1. Identify the version of Core API you would like to use (eg. 2022-04 or 2022-08). You can check the change log as well to confirm the version you would like to use.

2. Add the version to the version to the API request URL.

2022-08

curl --X --request GET 'https://{{cluster_name}}-{{client_name}}/api/2022-08/crm/customers \
--header 'Content-Type: application/json; charset=UTF-8', `Authorization: Bearer INSERT_TOKEN_HERE'

2022-04

curl --X --request GET 'https://{{cluster_name}}-{{client_name}}/api/2022-04/crm/customers \
--header 'Content-Type: application/json; charset=UTF-8', `Authorization: Bearer INSERT_TOKEN_HERE'

OR

curl --X --request GET 'https://{{cluster_name}}-{{client_name}}/tulip_api/v2/crm/customers \
--header 'Content-Type: application/json; charset=UTF-8', `Authorization: Bearer INSERT_TOKEN_HERE'

Note: All new standard of Core API endpoints can only be accessed with version date of: 2022-08. Refer to the change log for more details.