Skip to content

Introduction

Adaptix provides a REST API to manipulate leads and/or obtain information for various entities of Adaptix.

 

All Adaptix API endpoints require an OAuth1a signtature or OAuth2 access token.

Error Handling

If an OAuth error is encountered, it'll be a JSON encoded array similar to:

1
2
3
4
{
  "error": "invalid_grant",
  "error_description": "The access token provided has expired."
}

If a system error encountered, it'll be a JSON encoded array similar to:

1
2
3
4
5
6
{
    "error": {
        "message": "You do not have access to the requested area/action.",
        "code": 403
    }
}

Adaptix version check

In case your API service wants to support several Adaptix versions with different features, you might need to check the version of Adaptix you communicate with. Since Adaptix 2.4.0 the version number is added to all API response headers. The header name is Adaptix-Version. With Adaptix PHP API library you can get the Adaptix version like this:

1
2
3
4
5
6
// Make any API request:
$api = $this->getContext('contacts');
$response = $api->getList('', 0, 1);

// Get the version number from the response header:
$version = $api->getAdaptixVersion();
$version will be in a semantic versioning format: [major].[minor].[patch]. For example: 2.4.0. If you'll try it on the latest BitBucket version, the version will have -dev at the end. Like 2.5.1-dev.