API Reference

Integrate Env's environmental monitoring, carbon tracking, and compliance reporting directly into your applications. RESTful, versioned, and documented.

BASE https://api.env.io/v1

Authentication

All API requests require a valid API key passed in the Authorization header. Keys can be generated in your Env Dashboard.

Authorization: Bearer <your_api_key>
Content-Type: application/json

Endpoints

GET /organizations/{org_id}/carbon-footprint Retrieves aggregated carbon metrics

Returns historical and real-time carbon emissions data for the specified organization, scoped by activity type.

ParameterTypeRequiredDescription
org_idstringRequiredOrganization UUID
start_dateISO 8601OptionalStart of reporting period
end_dateISO 8601OptionalEnd of reporting period
 
{
  "total_co2e_kg": 14250.8,
  "scope_1": 3200.5,
  "scope_2": 5100.2,
  "scope_3": 5950.1,
  "period": { "start": "2024-01-01", "end": "2024-12-31" },
  "unit": "kgCO2e"
}
\n
POST /reports/generate Creates a new ESG compliance report

Triggers asynchronous generation of a standardized ESG report (GRI/SASB/TCFD). Returns a job ID for polling.

ParameterTypeRequiredDescription
formatstringRequiredReport standard: `gri`, `sasb`, `tcfd`
include_supply_chainbooleanOptionalInclude Scope 3 data
 
{
  "job_id": "rpt_8x92kf3m", 
  "status": "queued",
  "estimated_completion": "2025-03-15T14:30:00Z",
  "callback_url": null
}
GET /compliance/status/{regulation_id} Checks regulatory compliance

Returns current compliance status against a specific environmental regulation or framework.

{
  "regulation": "EU-CSRD",
  "compliance_score": 88.5,
  "status": "partially_compliant",
  "missing_artifacts": [
    "audit_trail_q3",
    "board_approval_doc"
  ],
  "last_updated": "2025-03-10T09:15:00Z"
}

📦 Postman Collection

Import our complete Postman collection to interact with the Env API directly from your workspace. Includes pre-configured environments, automated tests, and example payloads.

  1. Download the collection JSON file
  2. Open Postman → File → Import
  3. Select the downloaded file and click "Import"
  4. Configure your API_KEY in the collection variables
  5. Run the "Smoke Test" folder to verify connectivity
{\n \"info\": {\n \"name\": \"Env API v1\",\n \"schema\": \"https://schema.getpostman.com/json/collection/v2.1.0/collection.json\"\n },\n \"auth\": {\n \"type\": \"bearer\",\n \"bearer\": [{ \"key\": \"token\", \"value\": \"{{API_KEY}}\", \"type\": \"string\" }]\n },\n \"variable\": [{ \"key\": \"API_KEY\", \"value\": \"\" }],\n \"item\": [\n {\n \"name\": \"Carbon Footprint\",\n \"request\": {\n \"method\": \"GET\",\n \"header\": [],\n \"url\": {\n \"raw\": \"{{BASE_URL}}/organizations/{{ORG_ID}}/carbon-footprint\",\n \"host\": [\"{{BASE_URL}}\"],\n \"path\": [\"organizations\", \"{{ORG_ID}}\", \"carbon-footprint\"]\n }\n }\n }\n ]\n}