Documentation menu

EventZero API documentation

EventZero API v2 (v2.0.0) is a JSON REST API over the EventZero data model: events, per-event carbon-source records, an approval workflow, and computed carbon results — 166 operations across 96 endpoints, all strictly scoped to your organization.

Base URL

All endpoints in these docs are relative to the live base URL. The QA environment is the only live environment today — see Environments.

https://api.carbon-calculator.eventzero.io/api/v2

Response envelope

Every JSON response uses one envelope. Successful responses wrap their payload in data; errors carry a stable machine-readable code you can branch on.

// success
{ "success": true, "data": { /* resource or { items, pagination } */ } }

// error
{ "success": false, "error": { "code": "NOT_FOUND", "message": "…", "details": { } } }

How these docs are organised

  • Getting started — the quickstart walks the happy path end to end; authentication covers tokens and credential handling.
  • Concepts — org scoping, roles, the approval workflow, pagination, errors, and rate limits: the rules every endpoint shares, documented once.
  • API reference — generated from the same OpenAPI document the API serves, so paths, parameters and responses match the deployed contract.

Getting access

The docs are public; credentials are not. API access is provisioned on partner and enterprise plans — request API access and we'll set up your organization.

No sandbox yet: Requests run against your organization's real data and count toward real plan quotas. Prefer a dedicated test event for integration development.