Before you start
You need to have a Quatrix account to access Quatrix APIs. If you haven’t registered yet, set up a free trial account here.
Quatrix maintains state throughout the session, for that reason you need a unique API key for each session. You can use HTTP basic authentication to authorize the requests which means you can simply send the user name and password associated with the account. If you create a basic authentication header manually, stick to the following rules:
The user email and password should be combined with a single colon (:) e.g.
- The resulting string is encoded using a variant of Base64.
The authorization method (e.g. Basic) should be prepended to the encoded string and separated with space. This is further used as a value for Authorization field. e.g.
Follow these steps to authorize with Basic authentication;
- Open Swagger, paste your URL (https://yourcompany.quatrix.it/swagger/quatrix.json/) into the blank field and click on the Explore button. This will display the list of available resources.
Click on the Authorize button that will open Available authorizations window, fill in your user name and password in Basic authorization section and press the Authorize button.
- Go to Auth resource and make GET /session/log in API call to retrieve a session ID = API key. See the screenshot.
Go back to the Authorize button and paste the session ID into the Value field in the API key section.
- Click on the Authorize button.
Once authorized, you can make any call by clicking first on the Try it out button and then on the Execute button that will provide results in the response.
Subsequent API calls are authorized using this key. The key is valid/active for 15 minutes since the last API action. If there was no activity during this period, the API key will expire, and the user must generate a new one.
When you are authorized, you can make almost all API calls, however there are some that require no authorization e.g. containing security:  GET /account/logo.
We use RESTful design patterns for URLs and our API methods support GET and POST requests. Each method operates on a certain resource (view the list of resources below) and produces a JSON response.
|Auth||Authenticate Quatrix account|
|Account||Get general information about the current account account|
|Language||Get details about account language|
|Contact||Create and manage contacts|
|PGP||Generate and manage PGP keys|
|Group||Get information about users and contacts|
|File||Retrieve and modify files/folders (hereinafter files)|
|Password reset||Reset password for existing users|
Preview photos, videos or files
|Profile||Update profile information of the user|
|MFA||Enable and disable MFA|
|Project folder||Create and manage project folders|
|Site settings||Manage service settings|
|User||Create and manage users|
|Widget||Set the widget|
|Share||Create shares, quick links, file sharing requests|
|Activity log||Track activity history|
|Service||Get information about the service|
|Automation||Create and administer automatic rules|
|Inbox||Activity tracking of a logged-in contact|
|SSH key||Create and manage SSH keys|
You can try out our APIs using Swagger where you can dig deeper into each resource and explore related endpoints with possible HTTP methods.
The base URL for API calls should be formatted in the following way:
The current API version is 1.0.
Conventional HTTP response codes are used to indicate the success or failure of an API request. When an error occurs, it contains an error code and the description so that you can easily identify the problem and solve it.
In general, we use codes in the range of 2хх to indicate the success of the request. E.g. 200 – login success response. Codes in the range of 4хх display the API request failure due to e.g. 400 – parameter error, or 401 - CAPTCHA is wrong.
We use the following model to display an error where the message displays general information about an error, and details specifies additional information about it.
The table below lists codes with their general descriptions.
|10||Bad parameter value|
|12||Bad host name|
|40||Operation not supported|
|51||PGP disabled error|
|61||Not allowed without set up 2FA|
|71||Not allowed without set up 2FA|
|72||Not allowed without password|
|73||Not allowed without PIN|
|74||Not allowed without CAPTCHA|
|75||Not allowed without Basic Auth|
|76||Not allowed IP restriction|
|77||Current IP not in IPR masks|
|78||Widget CAPTCHA required|
|79||Widget file limit|
|91||Widget doesn't exist|
If you have any problems with integration, code or something urgent, feel free to contact us via phone or email.
Int & UK: +44 (0) 1892 861 222 | USA: 1 800 592 1906