Skip to main content
GET
Get Climate Impact Data

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Subaccount-Id
string

If present, will only include orders for the subaccount with given id when calculating total impact.

Query Parameters

from
string | null

Optionally specifies the start of the time period of orders to include in the impact calculation. If omitted, then orders starting from account creation are included. If present, must be a date in ISO 8601 format.

to
string | null

Optionally specifies the end of the time period of orders to include in the impact calculation. If omitted, then orders up to the present time are included. If present, must be a date in ISO 8601 format.

Response

Impact Data

name
string | null

The name for the account or subaccount whose impact data is being retrieved

Example:

"Acme, Inc"

logo_url
string | null

URL for the logo of the account or subaccount whose impact data is being retrieved

Example:

"https://customer-assets.cnaught.com/fe0df075-30e2-4e58-9feb-154e72a9205f/company_logo.png"

total_offset_kgs
number

Amount (in kg of CO₂e) of total credits retired for this account or subaccount

Example:

100000

equivalents
object

Equivalent quantities to illustrate the climate impact of the total credits retired

since_date
string

If an explicit "from" date was specified for the impact data request, then this is the requested "from" date. Otherwise, this is the date on which the account / subaccount began using CNaught to take climate action.

Example:

"2023-01-01T18:00:00.000000Z"

to_date
string | null

If an explicit "to" date was specified for the impact data request, then this is the requested "to" date. Otherwise, this is null.

Example:

"2023-10-01T18:00:00.000000Z"

categories
object[]

The categories that contributed to the impact for this account or subaccount, and details about their contribution to the overall impact