Energy performance diagnostics (DPE)
List all energy performance diagnoses
Retrieves all energy performance diagnoses for the current tenant, sorted by creation date descending
query Parameters
pagePage number (default: 1)
limitNumber of items per page (default: 20, max: 100)
estate_idFilter by property ID
place_idFilter by place ID
energy_labelFilter by energy label
DPE energy label (A to G)
ges_labelFilter by GHG (greenhouse gas) label
DPE GHG (Greenhouse Gas) label (A to G)
List all energy performance diagnoses › Responses
Energy performance diagnoses retrieved successfully
Create an energy performance diagnosis
Creates a new energy performance diagnosis. Must specify either estate_id or place_id, but not both
Create an energy performance diagnosis › Request Body
reference_numberDPE reference number
diagnosis_dateDiagnosis date
valid_untilDiagnosis validity date (10 years maximum)
energy_labelDPE energy label (A to G)
ges_labelDPE GHG (Greenhouse Gas) label (A to G)
construction_yearConstruction year of the property
estate_idProperty (required if place_id is not provided) ID
place_idPlace (required if estate_id is not provided) ID
energy_consumptionEnergy consumption in kWh/m²/year
ges_emissionGHG emission in kg CO2/m²/year
heated_areaHeated area in m²
diagnostician_contact_idDiagnostician contact ID
notesInternal notes about the diagnosis
media_idMedia ID of the uploaded DPE PDF document
Create an energy performance diagnosis › Responses
Energy performance diagnosis created successfully
idUnique identifier of the DPE
reference_numberDPE reference number
diagnosis_dateDiagnosis date
valid_untilDiagnosis validity date (10 years maximum)
energy_labelDPE energy label (A to G)
ges_labelDPE GHG (Greenhouse Gas) label (A to G)
construction_yearConstruction year of the property
created_atCreation date
updated_atLast modification date
estate_idProperty (if DPE for a specific property) ID
place_idPlace (if DPE for a specific place) ID
energy_consumptionEnergy consumption in kWh/m²/year
ges_emissionGHG emission in kg CO2/m²/year
heated_areaHeated area in m²
diagnostician_contact_idDiagnostician contact ID
notesInternal notes about the diagnosis
media_idMedia ID of the uploaded DPE PDF document
Get energy performance diagnosis by ID
Retrieves a specific energy performance diagnosis by its unique identifier
path Parameters
idEnergy performance diagnosis ID
Get energy performance diagnosis by ID › Responses
Energy performance diagnosis retrieved successfully
idUnique identifier of the DPE
reference_numberDPE reference number
diagnosis_dateDiagnosis date
valid_untilDiagnosis validity date (10 years maximum)
energy_labelDPE energy label (A to G)
ges_labelDPE GHG (Greenhouse Gas) label (A to G)
construction_yearConstruction year of the property
created_atCreation date
updated_atLast modification date
estate_idProperty (if DPE for a specific property) ID
place_idPlace (if DPE for a specific place) ID
energy_consumptionEnergy consumption in kWh/m²/year
ges_emissionGHG emission in kg CO2/m²/year
heated_areaHeated area in m²
diagnostician_contact_idDiagnostician contact ID
notesInternal notes about the diagnosis
media_idMedia ID of the uploaded DPE PDF document
Update energy performance diagnosis
Updates an existing energy performance diagnosis
path Parameters
idEnergy performance diagnosis ID
Update energy performance diagnosis › Request Body
reference_numberDPE reference number
diagnosis_dateDiagnosis date
valid_untilDiagnosis validity date (10 years maximum)
energy_labelDPE energy label (A to G)
energy_consumptionEnergy consumption in kWh/m²/year.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)- Numeric value: the value is updated
ges_labelDPE GHG (Greenhouse Gas) label (A to G)
ges_emissionGHG emission in kg CO2/m²/year.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)- Numeric value: the value is updated
heated_areaHeated area in m².
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)- Numeric value: the value is updated
construction_yearConstruction year of the property
diagnostician_contact_idDiagnostician contact ID.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)- Valid UUID: the value is updated
notesAdditional notes about the diagnosis.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)- String value: the value is updated
media_idMedia ID of the uploaded DPE PDF document.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)- Valid UUID: the value is updated
Update energy performance diagnosis › Responses
Energy performance diagnosis updated successfully
idUnique identifier of the DPE
reference_numberDPE reference number
diagnosis_dateDiagnosis date
valid_untilDiagnosis validity date (10 years maximum)
energy_labelDPE energy label (A to G)
ges_labelDPE GHG (Greenhouse Gas) label (A to G)
construction_yearConstruction year of the property
created_atCreation date
updated_atLast modification date
estate_idProperty (if DPE for a specific property) ID
place_idPlace (if DPE for a specific place) ID
energy_consumptionEnergy consumption in kWh/m²/year
ges_emissionGHG emission in kg CO2/m²/year
heated_areaHeated area in m²
diagnostician_contact_idDiagnostician contact ID
notesInternal notes about the diagnosis
media_idMedia ID of the uploaded DPE PDF document
List energy performance diagnoses for a place
Retrieves all energy performance diagnoses associated with a specific place
path Parameters
place_idPlace ID
List energy performance diagnoses for a place › Responses
Energy performance diagnoses for the place retrieved successfully
idUnique identifier of the DPE
reference_numberDPE reference number
diagnosis_dateDiagnosis date
valid_untilDiagnosis validity date (10 years maximum)
energy_labelDPE energy label (A to G)
ges_labelDPE GHG (Greenhouse Gas) label (A to G)
construction_yearConstruction year of the property
created_atCreation date
updated_atLast modification date
estate_idProperty (if DPE for a specific property) ID
place_idPlace (if DPE for a specific place) ID
energy_consumptionEnergy consumption in kWh/m²/year
ges_emissionGHG emission in kg CO2/m²/year
heated_areaHeated area in m²
diagnostician_contact_idDiagnostician contact ID
notesInternal notes about the diagnosis
media_idMedia ID of the uploaded DPE PDF document
List energy performance diagnoses for a property
Retrieves all energy performance diagnoses associated with a specific property
path Parameters
place_idPlace ID
estate_idProperty ID
List energy performance diagnoses for a property › Responses
Energy performance diagnoses for the property retrieved successfully
idUnique identifier of the DPE
reference_numberDPE reference number
diagnosis_dateDiagnosis date
valid_untilDiagnosis validity date (10 years maximum)
energy_labelDPE energy label (A to G)
ges_labelDPE GHG (Greenhouse Gas) label (A to G)
construction_yearConstruction year of the property
created_atCreation date
updated_atLast modification date
estate_idProperty (if DPE for a specific property) ID
place_idPlace (if DPE for a specific place) ID
energy_consumptionEnergy consumption in kWh/m²/year
ges_emissionGHG emission in kg CO2/m²/year
heated_areaHeated area in m²
diagnostician_contact_idDiagnostician contact ID
notesInternal notes about the diagnosis
media_idMedia ID of the uploaded DPE PDF document