💡 Full API documentation is available at docs.altruistiq.com
The Altruistiq REST API lets you programmatically administer and change your reference and calculation input data in Altruistiq.
Using the available API endpoints, you can programmatically do any the following and more:
Create and edit Facilities, as well as their Areas
Create and edit Product, as well as their Bills of Materials
Upload calculation input data to Data Sources
Export data from your Corporate Carbon Footprint
Export Product Carbon Footprint data aligned to the PACT standard
For assistance with the API, contact Altruistiq Support through [email protected] or Ask Your Advisor
User & System Requirements
Accessing the API requires the user to have an API Secret for authentication
Generating an Secret requires Admin role
Accessing this feature requires the organisation to be on Altruistiq Advanced, Altruistiq Enterprise (legacy) or Altruistiq Business (legacy)
About the API
The Altruistiq API is built around REST principles, leveraging the OpenAPI specification. It is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. It uses built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.
The API uses OAUTH 2.0 authentication. Endpoints accept JSON in the request body and can include JSON in the response body. Responses from Export API can include CSV formats as the response body. The API is documented at docs.altruistiq.com
Use of the API is governed by the legal agreement governing your use of the Altruistiq Platform
Generate API keys
Create secure API keys to connect external applications with your Altruistiq account and automate data flows.
What are API keys?
API keys are like digital passwords that let other applications access your Altruistiq data securely. Think of them as special access cards that:
Only work for specific tasks you've approved
Can be revoked anytime
Keep your main login credentials safe
Generate a new API key
Click your profile menu (top right corner)
Select Organisation settings
Navigate to Authentication and scroll down to Integrations
Click Create
Configure your key's label and copy the Secret
Name your key
Choose a descriptive name that identifies:
Which application will use it (e.g., "Power BI Dashboard Connection")
Its purpose (e.g., "Monthly Emissions Data Export")
💡 Best practices for key management
Choose a descriptive key Label that identifies:
Which API will use it (e.g., "Export API")
Its purpose (e.g., "Monthly Corporate Footprint Data Export")
Store secrets in a secure vault (e.g. AWS Secrets Manager, GCP Secret Manager, HashiCorp Vault).
Manage existing API keys
In the same Integrations section mentioned above, you have the ability to quickly rotate or delete existing secrets to manage ongoing security.
