Green Project API (1.0.5)

Download OpenAPI specification:Download

E-mail: supoprt@greenprojecttech.com License: Apache 2.0

Green Project API for partner Partnership

company

Requests about a company's environmental data

returns a list of companies which the partner is authorized to access.

Authorizations:

oAuthNoScopes

Responses

Response samples

200

Content type

application/json

[{"value": {"Demo Company": {"gpt_company_id": "6356aa2432f35c1fcdbbe579",
"partner_company_id": "partner-12345",
"gpt_company_name": "Demo Company",
"frequency": "quarterly"
}
}
}
]

Returns details about the specified company

Authorizations:

oAuthNoScopes

path Parameters

companyId

required

string <uuid>

the GPT ID of a company

Responses

Response samples

200

Content type

application/json

{"gpt_company_id": "62ba058cfb154f9a49d6ac03",
"partner_company_id": "partner-cust-abcd1234",
"gpt_company_name": "Example PortCo A",
"frequency": "quarterly",
"data_years": [{"status": "IN_PROGRESS",
"last_updated": "2017-07-21T17:32:28Z",
"data_year": 2022
}
]
}

emissions

Returns aggregated emissions totals for the year broken down by business unit

Authorizations:

oAuthNoScopes

path Parameters

company_id required	string <uuid> the ID of a company (partner must be authorized to access this company)
year required	number Example: 2021 returns annual emissions summary for company, regardless of the company's frequency

Responses

Response samples

200

Content type

application/json

{"data_properties": {"partner_company_id": "partner-cust-1234",
"status": "IN_PROGRESS",
"last_updated": "2022-07-21T17:32:28Z"
},
"location_based_emissions": [{"pencils - manufacturing": {"business_unit": "pencils - manufacturing",
"scope1": {"stationary_combustion": 1.1,
"mobile_combustion": 1.2,
"fugitive_and_processed_emissions": 1.3,
"scope_1_total": 3.6
},
"scope2": {"purchased_electricity": 2.1,
"thermal_use": 2.3,
"scope_2_total": 4.4
},
"scope3": {"purchased_goods_and_services": 1.1,
"capital_goods": 1.2,
"fuel_and_energy_related_activities": 1.3,
"upstream_transportation_and_distribution": 1.4,
"waste": 1.5,
"business_travel": 1.6,
"employee_commuting": 1.7,
"upstream_leased_assets": 1.8,
"downstream_transportation_and_distribution": 1.9,
"processing_of_sold_products": 2,
"use_of_sold_products": 2.1,
"eol_of_sold_products": 2.2,
"downstream_leased_assets": 2.3,
"franchises": 2.4,
"investments": 2.5,
"scope_3_total": 27
},
"is_total": false,
"methodology": "location"
},
"default": {"business_unit": "default",
"scope1": {"stationary_combustion": 1.1,
"mobile_combustion": 1.2,
"fugitive_and_processed_emissions": 1.3,
"scope_1_total": 3.6
},
"scope2": {"purchased_electricity": 2.1,
"thermal_use": 2.3,
"scope_2_total": 4.4
},
"scope3": {"purchased_goods_and_services": 1.1,
"capital_goods": 1.2,
"fuel_and_energy_related_activities": 1.3,
"upstream_transportation_and_distribution": 1.4,
"waste": 1.5,
"business_travel": 1.6,
"employee_commuting": 1.7,
"upstream_leased_assets": 1.8,
"downstream_transportation_and_distribution": 1.9,
"processing_of_sold_products": 2,
"use_of_sold_products": 2.1,
"eol_of_sold_products": 2.2,
"downstream_leased_assets": 2.3,
"franchises": 2.4,
"investments": 2.5,
"scope_3_total": 27
},
"is_total": false,
"methodology": "location"
},
"total": {"business_unit": "total",
"scope1": {"stationary_combustion": 1.1,
"mobile_combustion": 1.2,
"fugitive_and_processed_emissions": 1.3,
"scope_1_total": 3.6
},
"scope2": {"purchased_electricity": 2.1,
"thermal_use": 2.3,
"scope_2_total": 4.4
},
"scope3": {"purchased_goods_and_services": 1.1,
"capital_goods": 1.2,
"fuel_and_energy_related_activities": 1.3,
"upstream_transportation_and_distribution": 1.4,
"waste": 1.5,
"business_travel": 1.6,
"employee_commuting": 1.7,
"upstream_leased_assets": 1.8,
"downstream_transportation_and_distribution": 1.9,
"processing_of_sold_products": 2,
"use_of_sold_products": 2.1,
"eol_of_sold_products": 2.2,
"downstream_leased_assets": 2.3,
"franchises": 2.4,
"investments": 2.5,
"scope_3_total": 27
},
"is_total": true,
"methodology": "location"
}
}
],
"market-based_emissions": [{"pencils - manufacturing": {"business_unit": "pencils - manufacturing",
"scope1": {"stationary_combustion": 1.1,
"mobile_combustion": 1.2,
"fugitive_and_processed_emissions": 1.3,
"scope_1_total": 3.6
},
"scope2": {"purchased_electricity": 2.1,
"thermal_use": 2.3,
"scope_2_total": 4.4
},
"scope3": {"purchased_goods_and_services": 1.1,
"capital_goods": 1.2,
"fuel_and_energy_related_activities": 1.3,
"upstream_transportation_and_distribution": 1.4,
"waste": 1.5,
"business_travel": 1.6,
"employee_commuting": 1.7,
"upstream_leased_assets": 1.8,
"downstream_transportation_and_distribution": 1.9,
"processing_of_sold_products": 2,
"use_of_sold_products": 2.1,
"eol_of_sold_products": 2.2,
"downstream_leased_assets": 2.3,
"franchises": 2.4,
"investments": 2.5,
"scope_3_total": 27
},
"is_total": false,
"methodology": "market"
},
"default": {"business_unit": "default",
"scope1": {"stationary_combustion": 1.1,
"mobile_combustion": 1.2,
"fugitive_and_processed_emissions": 1.3,
"scope_1_total": 3.6
},
"scope2": {"purchased_electricity": 2.1,
"thermal_use": 2.3,
"scope_2_total": 4.4
},
"scope3": {"purchased_goods_and_services": 1.1,
"capital_goods": 1.2,
"fuel_and_energy_related_activities": 1.3,
"upstream_transportation_and_distribution": 1.4,
"waste": 1.5,
"business_travel": 1.6,
"employee_commuting": 1.7,
"upstream_leased_assets": 1.8,
"downstream_transportation_and_distribution": 1.9,
"processing_of_sold_products": 2,
"use_of_sold_products": 2.1,
"eol_of_sold_products": 2.2,
"downstream_leased_assets": 2.3,
"franchises": 2.4,
"investments": 2.5,
"scope_3_total": 27
},
"is_total": false,
"methodology": "market"
},
"total": {"business_unit": "total",
"scope1": {"stationary_combustion": 1.1,
"mobile_combustion": 1.2,
"fugitive_and_processed_emissions": 1.3,
"scope_1_total": 3.6
},
"scope2": {"purchased_electricity": 2.1,
"thermal_use": 2.3,
"scope_2_total": 4.4
},
"scope3": {"purchased_goods_and_services": 1.1,
"capital_goods": 1.2,
"fuel_and_energy_related_activities": 1.3,
"upstream_transportation_and_distribution": 1.4,
"waste": 1.5,
"business_travel": 1.6,
"employee_commuting": 1.7,
"upstream_leased_assets": 1.8,
"downstream_transportation_and_distribution": 1.9,
"processing_of_sold_products": 2,
"use_of_sold_products": 2.1,
"eol_of_sold_products": 2.2,
"downstream_leased_assets": 2.3,
"franchises": 2.4,
"investments": 2.5,
"scope_3_total": 27
},
"is_total": true,
"methodology": "market"
}
}
]
}

Returns aggregated emissions totals for the specified year at the specified business unit

Authorizations:

oAuthNoScopes

path Parameters

company_id required	string <uuid> the ID of a company (c)
year required	number Example: 2021 the year for which to get data
business_unit required	string Example: pencils - sales the business unit code from partner

Responses

Response samples

200

Content type

application/json

{"data_properties": {"partner_company_id": "partner-cust-1234",
"status": "IN_PROGRESS",
"last_updated": "2022-07-21T17:32:28Z",
"business_unit": "pencils - manufacturing"
},
"location-based_emissions": [{"pencils - manufacturing": {"business_unit": "pencils - manufacturing",
"scope1": {"stationary_combustion": 1.1,
"mobile_combustion": 1.2,
"fugitive_and_processed_emissions": 1.3,
"scope_1_total": 3.6
},
"scope2": {"purchased_electricity": 2.1,
"thermal_use": 2.3,
"scope_2_total": 4.4
},
"scope3": {"purchased_goods_and_services": 1.1,
"capital_goods": 1.2,
"fuel_and_energy_related_activities": 1.3,
"upstream_transportation_and_distribution": 1.4,
"waste": 1.5,
"business_travel": 1.6,
"employee_commuting": 1.7,
"upstream_leased_assets": 1.8,
"downstream_transportation_and_distribution": 1.9,
"processing_of_sold_products": 2,
"use_of_sold_products": 2.1,
"eol_of_sold_products": 2.2,
"downstream_leased_assets": 2.3,
"franchises": 2.4,
"investments": 2.5,
"scope_3_total": 27
},
"is_total": false,
"methodology": "location"
}
}
],
"market-based_emissions": [{"pencils - manufacturing": {"business_unit": "pencils - manufacturing",
"scope1": {"stationary_combustion": 1.1,
"mobile_combustion": 1.2,
"fugitive_and_processed_emissions": 1.3,
"scope_1_total": 3.6
},
"scope2": {"purchased_electricity": 2.1,
"thermal_use": 2.3,
"scope_2_total": 4.4
},
"scope3": {"purchased_goods_and_services": 1.1,
"capital_goods": 1.2,
"fuel_and_energy_related_activities": 1.3,
"upstream_transportation_and_distribution": 1.4,
"waste": 1.5,
"business_travel": 1.6,
"employee_commuting": 1.7,
"upstream_leased_assets": 1.8,
"downstream_transportation_and_distribution": 1.9,
"processing_of_sold_products": 2,
"use_of_sold_products": 2.1,
"eol_of_sold_products": 2.2,
"downstream_leased_assets": 2.3,
"franchises": 2.4,
"investments": 2.5,
"scope_3_total": 27
},
"is_total": false,
"methodology": "market"
}
}
]
}

Returns aggregated emissions totals for the specified year, across all business units

Authorizations:

oAuthNoScopes

path Parameters

company_id required	string <uuid> the ID of a company (c)
year required	number Example: 2021 the year for which to get data

Responses

Response samples

200

Content type

application/json

{"data_properties": {"partner_company_id": "partner-cust-1234",
"status": "IN_PROGRESS",
"last_updated": "2022-07-21T17:32:28Z",
"business_unit": "total"
},
"location-based_emissions": [{"total": {"business_unit": "total",
"scope1": {"stationary_combustion": 1.1,
"mobile_combustion": 1.2,
"fugitive_and_processed_emissions": 1.3,
"scope_1_total": 3.6
},
"scope2": {"purchased_electricity": 2.1,
"thermal_use": 2.3,
"scope_2_total": 4.4
},
"scope3": {"purchased_goods_and_services": 1.1,
"capital_goods": 1.2,
"fuel_and_energy_related_activities": 1.3,
"upstream_transportation_and_distribution": 1.4,
"waste": 1.5,
"business_travel": 1.6,
"employee_commuting": 1.7,
"upstream_leased_assets": 1.8,
"downstream_transportation_and_distribution": 1.9,
"processing_of_sold_products": 2,
"use_of_sold_products": 2.1,
"eol_of_sold_products": 2.2,
"downstream_leased_assets": 2.3,
"franchises": 2.4,
"investments": 2.5,
"scope_3_total": 27
},
"is_total": true,
"methodology": "location"
}
}
],
"market-based_emissions": [{"total": {"business_unit": "total",
"scope1": {"stationary_combustion": 1.1,
"mobile_combustion": 1.2,
"fugitive_and_processed_emissions": 1.3,
"scope_1_total": 3.6
},
"scope2": {"purchased_electricity": 2.1,
"thermal_use": 2.3,
"scope_2_total": 4.4
},
"scope3": {"purchased_goods_and_services": 1.1,
"capital_goods": 1.2,
"fuel_and_energy_related_activities": 1.3,
"upstream_transportation_and_distribution": 1.4,
"waste": 1.5,
"business_travel": 1.6,
"employee_commuting": 1.7,
"upstream_leased_assets": 1.8,
"downstream_transportation_and_distribution": 1.9,
"processing_of_sold_products": 2,
"use_of_sold_products": 2.1,
"eol_of_sold_products": 2.2,
"downstream_leased_assets": 2.3,
"franchises": 2.4,
"investments": 2.5,
"scope_3_total": 27
},
"is_total": true,
"methodology": "market"
}
}
]
}

surveys

POST a CSV file formatted according to Green Project's data ingestion format

Authorizations:

oAuthNoScopes

path Parameters

companyId

required

string

The ID of the company (client must be authorized to access this company's data)

query Parameters

year required	number Example: year=2022 Survey data year
period required	string Enum: "q1" "q2" "q3" "q4" "yr" "jan" "feb" "mar" "apr" "may" "jun" "jul" "aug" "sep" "oct" "nov" "dec" The survey period within the specified year

Request Body schema: application/csv

.csv file containing the data for the portfolio company for this survey period

string <base64>

Responses

Response samples

201

Content type

application/json

{"surveyId": "62bb256b44425ae8acb16b35",
"surveyStatus": "IN_PROGRESS"
}