Skip to content

API Overview

The CO2 platform exposes its integration contract through the API gateway:

  • Production gateway: https://api.co2targettracking.co.uk
  • Development gateway: https://dev.api.co2targettracking.co.uk
  • OpenAPI JSON: /openapi.json
  • Swagger UI: /swagger

This docs site does not treat a checked-in OpenAPI file as the source of truth. Instead:

  • the gateway serves the live openapi.json
  • this site lazy-loads that document when you open the live reference page
  • generated docs in this site focus on surrounding context, inventories, and navigation

That keeps the technical reference fresh without turning the docs repo into another contract registry.

  • Open the live API reference
  • Production Swagger UI: https://api.co2targettracking.co.uk/swagger
  • Development Swagger UI: https://dev.api.co2targettracking.co.uk/swagger

This site is a better home for:

  • environment and surface maps
  • integration onboarding
  • generated inventories of domains, apps, and policy packages
  • technical explanations of how the public surfaces fit together