Borealis API


Borealis’ API (Application Programming Interface) is available for all our modules. APIs allow different applications to communicate information to one another. In our case, this means that all the data you track and record in Borealis can either be imported from other applications, or automatically exported to them.

This means our users benefit from greater flexibility while working from their various apps. For instance, integrate your Google and Outlook contacts, monitor social media platforms, or integrate your other business applications like CRMs, HSE systems, GIS databases, etc.


How to generate an API Token and access the API Documentation

  1. Click on your Profile icon at the right of the top bar and click on View profile.
  2. Click on Access token in the record menu on the left. If you don't see Access token, it is because you do not have access to the API. Ask your superuser to grant you access.
  3. Click on the Create button to create a token. Enter the information and Save.
  4. A banner will appear with your token. Copy it and store it somewhere safe. You will not be able to access it again. You can create a new one if needed.
  5. Click on Read the API documentation to access the online documentation.


Use cases

Here are a few use cases of the Borealis API with applications you might be using on a daily basis. These will help you understand how the API works for you and how it can make your life a lot simpler.

Social media

The Borealis API lets you track what is happening in social media, whether it’s to monitor the different posts of your business page, to keep a history of what people post on this page, or even to follow some hashtags. For each of the example below, a communication will be created in the Borealis Application. With custom dashboards, you’ll be able to monitor monthly, weekly and daily mentions. Here is how it works for each platform:


Centralize all your business page’s posts in Borealis, including the date, content and a link to access the post. Please note that you must be the admin of the Facebook page you’d like to link to Borealis in order to be able to connect them. It’s also possible to centralize all the posts that users shared on your business page in Borealis.

Twitter and Instagram

Centralize all the tweets/posts of the business pages you’re an admin for in Borealis, including: date, content and a link the post. Furthermore, it’s possible to track as many hashtags as you want, like for instance #yourbusiness #yourproduct.


Centralize the history of all the videos shared by your channel. It’s also possible to track other channels: in either case, the Borealis Application will create a communication for each shared video.



If you’re using a CRM and Borealis, setting up the API will allow data entries in one of these applications to automatically be updated in the other. This means if you create a new entry in your CRM, the API will ensure this data is transferred in the Borealis Application. All new or updated fields in the CRM that are available in Borealis will therefore be updated. Updating all your apps will take half the time.




GIS database

Georeferenced data allows users to get a visual representation of assets, stakeholders and more, directly on a map. Transferring data from GIS systems into Borealis can therefore help teams linking grievances to a project site or a particular asset.




Another integration example is with WordPress, where you can generate an interface for your stakeholders, like for instance for a sponsorship request website. Stakeholders will be able to contact the organization without having to speak to an agent, to reach out to a call center, or any other communication platform your organization might be using. The WordPress page can be adapted to the information you’d like to gather from your stakeholders. In the example of a sponsorship request website, all the fields filled by the stakeholders will then populate Borealis.


These examples just demonstrate a few things that the Borealis API makes available for you. Please note that all the data that can be processed by our application can also be transferred to other applications, thanks to our API. There’s almost no limit to possible integrations!

Was this article helpful?
1 out of 2 found this helpful
Have more questions? Submit a request