---
title: "List canonical emission outputs"
method: GET
path: "/emissions/canonical"
tags: ["Emissions"]
---

# List canonical emission outputs

`GET /emissions/canonical`

## Query parameters

- `startDate` string, date-time
- `endDate` string, date-time
- `query` string
- `scope` integer[]
- `factorType` string[]
- `regionCode` string[]
- `locationId` string[]
- `categoryName` string[]
- `subCategoryName` string[]
- `activityType` string[]
- `supplierDisplay` string[]
- `amountUnit` string[]
- `origin` string[]
- `provenanceStatus` string[]
- `minCo2eTonnes` number
- `maxCo2eTonnes` number
- `documentId` string
- `item_type` 'carbon' | 'all'
- `cursor` string
- `limit` integer
- `page` integer
- `pageSize` integer

## Response `200`

Canonical emissions list

- CanonicalEmissionListResponse
  - `data` CanonicalEmissionList, required
    - `hasMore` boolean, required
    - `items` CanonicalEmissionItem[], required
      - `activityType` string, nullable
      - `amountUnit` string, nullable
      - `categoryName` string, nullable
      - `createdAt` string, date-time, required
      - `description` string, nullable
      - `editable` boolean, required
      - `endDate` string, date-time, nullable
      - `factorArchived` boolean, required — True when the linked factor entry was archived after this emission was created.
      - `factorDisplayName` string, nullable
      - `factorEntryId` string, nullable
      - `factorLibraryId` string, nullable
      - `factorProvenance` CanonicalFactorProvenance
      - `factorReleaseId` string, nullable
      - `factorValue` number, double, nullable
      - `id` string, required
      - `isCarbon` boolean, required
      - `locationDisplay` string, nullable
      - `locationId` string, nullable
      - `metricKind` 'emission_output', required
      - `name` string, required
      - `origin` 'template' | 'direct_upload', required
      - `provenanceStatus` 'authoritative', required
      - `rawValue` number, double, nullable
      - `scope` integer, nullable
      - `sourceFile` CanonicalEmissionSourceFile
        - `contentType` string, nullable
        - `fileName` string, required
        - `uploadId` string, required
      - `sourceRecordId` string, nullable
      - `sourceType` string, required
      - `spendCurrency` string, nullable
      - `spendValue` number, double, nullable
      - `startDate` string, date-time, required
      - `subCategoryName` string, nullable
      - `supplierDisplay` string, nullable
      - `supplierId` string, nullable
      - `unit` string, required
      - `value` number, double, required
    - `nextCursor` string, nullable
    - `page` integer
    - `pageSize` integer
    - `total` integer
  - `meta` object

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.dev/greentally/apis/esgai-api.md) · [All operations](https://skmtc.dev/greentally/apis/esgai-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/greentally/esgai-api/revisions/09945036a28b/schema)