Projects
Gets all projects
Returns a list of projects that match the provided filter criteria.
get/projects
Request
- Base URLhttps://api3.autarc.energy/v1
- AuthAPI key in header X-Api-Key
Query parameters
status'inProgress' | 'completed' | 'archived'
customerIdstring uuid nullable
technicalFeasibilityAssesment'feasible' | 'notFeasible' | 'notStarted'
isLeadboolean
sortBy'created_at' | 'updated_at' | 'name' | 'human_id'
limitinteger
Maximum number of projects returned per page (1–100). Defaults to 20.
order'asc' | 'desc'
pageinteger
Which page of results to retrieve (1-based). Default is 1.
Response
Successful projects list
Example response
{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Solar Installation - Residential",
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"createdAt": "2024-03-15T14:15:22Z",
"updatedAt": "2024-03-26T10:30:45Z",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"status": "inProgress",
"isLead": false,
"humanId": "PROJ-2024-001",
"hubspotDealId": "12345678901",
"projectValue": 45000,
"installationDate": "2024-06-01",
"buildingType": "singleOrDoubleFamilyHouse",
"buildingAge": "from2002",
"isMonumentProtected": false,
"numberOfResidents": 4,
"numberOfFloors": 2,
"heatedLivingAreaM2": 180,
"currentHeatingSystemType": "gas",
"currentHeatingSystemConstructionYear": "before1980",
"drinkingWaterHeatingSystemType": "withCirculation",
"heatingCircuits": [
{
"id": "hc_497f6e_01",
"name": "Ground Floor Heating",
"flowTemperature": 35,
"returnTemperature": 30,
"index": 0
},
{
"id": "hc_497f6e_02",
"name": "First Floor Heating",
"flowTemperature": 38,
"returnTemperature": 33,
"index": 1
}
],
"technicalFeasibilityAssesment": "feasible",
"avgHeatload": -40.03491807681978,
"yearlyEnergyConsumption": 10000,
"address": {
"addressLine1": "456 Secondary Ave",
"postalCode": "67890",
"city": "Another City",
"country": "Deutschland",
"countryCode": "DE",
"latitude": 48.7,
"longitude": 13.27
},
"buildingHeatLoadKw": 12.5,
"fullLoadHours": 1648.56,
"usageLevel": 0.83,
"consumptionBasedHeatload": -4.003,
"roomByRoomHeatloadKw": 0.973,
"area": 50,
"envelopeArea": 50,
"bruttoVolume": 131.5,
"heatloadPerArea": 19.46,
"heatloadPerVolume": 7.4,
"hasRoomWithCustomHeatLoad": false,
"groundTransmissionHeatLoss": 255.2,
"transmissionHeatLoss": 510.39,
"airTransmissionHeatLoss": 255.2,
"ventilationHeatLoss": 717.6,
"heatPumpSizing": {
"hotWaterConsumptionLiter": 250,
"hotWaterGenerationKwh": 29,
"heatPumpStandardOutputKw": 1.77,
"heatPumpBlockingHours": 0,
"bivalencePoint": -7,
"heatingLimitTemperature": 15
}
},
{
"id": "b0b73d03-06b4-47c7-80c7-59301f770123",
"name": "Energy Efficiency Retrofit",
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"createdAt": "2024-03-20T09:45:12Z",
"updatedAt": "2024-03-25T16:20:33Z",
"customerId": "a1b2c3d4-e5f6-4742-a86f-dbbb3bf522de",
"status": "inProgress",
"isLead": true,
"humanId": "PROJ-2024-002",
"projectValue": 65000,
"installationDate": "2024-07-15",
"buildingType": "singleOrDoubleFamilyHouse",
"buildingAge": "from2002",
"isMonumentProtected": false,
"numberOfResidents": 3,
"numberOfFloors": 3,
"heatedLivingAreaM2": 220,
"currentHeatingSystemType": "gas",
"currentHeatingSystemConstructionYear": "before1980",
"drinkingWaterHeatingSystemType": "withCirculation",
"heatingCircuits": [
{
"id": "hc_b0b73d_01",
"name": "Ground Floor Radiators",
"flowTemperature": 40,
"returnTemperature": 35,
"index": 0
}
],
"technicalFeasibilityAssesment": "feasible",
"avgHeatload": -40.03491807681978,
"yearlyEnergyConsumption": 10000,
"address": {
"addressLine1": "456 Secondary Ave",
"postalCode": "67890",
"city": "Another City",
"country": "Deutschland",
"countryCode": "DE",
"latitude": 48.7,
"longitude": 13.27
},
"buildingHeatLoadKw": null,
"fullLoadHours": null,
"usageLevel": null,
"consumptionBasedHeatload": null,
"roomByRoomHeatloadKw": null,
"area": null,
"envelopeArea": null,
"bruttoVolume": null,
"heatloadPerArea": null,
"heatloadPerVolume": null,
"hasRoomWithCustomHeatLoad": null,
"groundTransmissionHeatLoss": null,
"transmissionHeatLoss": null,
"airTransmissionHeatLoss": null,
"ventilationHeatLoss": null,
"heatPumpSizing": null
}
],
"metadata": {
"page": 1,
"limit": 2,
"total": "42"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.