v3

latestOpenAPI 3.1.02026-08-0797185285.8 KB

Get Ghg Statement

Get a single GHG statement

get/ghg_statements/{id}

Path parameters

idstring required

Example:ggs_1GDQJ99Z51S0DYW9

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Response

Successful Response

idstring required

project_idstring required

verifierstring nullable required

Name of the verifier of the GHG statement

removal_idsstring[] required

ghg_entry_idsstring[] required

ghg_statement_report_urlstring nullable required

status'DRAFT' | 'AWAITING_VERIFICATION' | 'VERIFIED' | 'CREDITS_ISSUED' | 'FAILED_VERIFICATION' required

reporting_period_start_atstring date required

Start date of the reporting period (inclusive)

reporting_period_end_atstring date required

End date of the reporting period (inclusive)

submitted_atstring date-time nullable required

credits_issued_atstring date-time nullable required

pending_total_co2e_removed_kgnumber nullable required

If the GHG statement has pending changes, this is the net CO₂e removed by the entries in the GHG statement, including any changes that are pending. If the GHG statement has no pending changes, this is None.

Example response

{
  "id": "ggs_1GDQJ99Z51S0DYW9",
  "project_id": "prj_1CTWZQGKE1S0VAXA",
  "removal_ids": [
    "rmv_1EEM6NJXX1S0EXKD"
  ],
  "ghg_entry_ids": [
    "rmv_1EEM6NJXX1S0EXKD"
  ]
}