Sign in

v1

latestOpenAPI 3.1.02026-07-24398280.9 KB
Carbon accounting

Retrieve monthly emissions summaries by business entity

Use this endpoint to retrieve emissions summaries by emissions source

get/v1/carbon_accounting/summaries/monthly_business_entity_emissions_summaries

Query parameters

fiscal_yearstring
Example:2025

Filter by a specific fiscal year, using the organization's fiscal start month setting

calendar_yearstring
Example:2025

Filter by a specific calendar year

monthstring
Example:2025-03

Filter by a specific month in YYYY-MM format

from_monthstring
Example:2025-03

Filter starting at a specific month, inclusive. Can optionally use with to_month.

to_monthstring
Example:2025-03

Filter up to a specific month, inclusive. Can optionally use with from_month.

business_entity_idsBusinessEntityID[]

A list of business entity UUIDs to filter against, returning summaries for the specificed business entities

parent_business_entity_idstring uuid

A business entity UUIDs to filter against, returning summaries for business entities one level below the given parent

business_entity_type_idstring uuid

A business entity type to filter against, returning summaries for business entities of this type

Response

Monthly emissions source summaries retrieved successfully.

Example response

{
  "summaries": [
    {
      "month": "2025-03"
    }
  ]
}