AUautarc
Projects

Creates a project

post/projects

Request

  • Base URL
    https://api3.autarc.energy/v1
  • Auth
    API key in header X-Api-Key

Request body

namestring required
source'internal' | 'hubspot' | 'check' | 'hero' | 'marketplace' | 'zapier' | 'api' | 'leadEmail' | 'leadFinder' | 'pipedrive'
currentStageIdstring uuid nullable

The ID of the project stage. Use the /project-stages endpoint to list available stages.

customerIdstring uuid nullable
status'inProgress' | 'completed' | 'archived'
isLeadboolean nullable

Determines if the project is a lead project

humanIdstring nullable

Human readable identifier. E.g. "P-001"

projectValuenumber float nullable

The value of the project. E.g. 10.000EUR

installationDatestring date nullable
buildingType'singleOrDoubleFamilyHouse' | 'semiDetachedHouse' | 'terracedHouse' | 'endTerracedHouse' | 'multiFamilyHouse' | 'commercialBuilding'
buildingAge'from2002' | 'from1995To2001' | 'from1984To1994' | 'from1979To1983' | 'from1969To1978' | 'from1958To1968' | 'from1949To1957' | 'from1919To1948' | 'before1918'
isMonumentProtectedboolean

Determines if the building is monument protected

numberOfResidentsnumber nullable

The number of residents in the building

numberOfFloorsnumber nullable

The number of floors in the building

heatedLivingAreaM2number nullable

The heated living area in square meters. Used in the heat pump check. This is an independent value and not the total sum of room areas.

currentHeatingSystemType'gas' | 'oil' | 'condensingGas' | 'condensingOil' | 'pellet' | 'electric' | 'districtOrOther'
currentHeatingSystemConstructionYear'before1980' | 'between1980And1995' | 'after1995'
drinkingWaterHeatingSystemType'withCirculation' | 'withoutCirculation'
isFacadeInsulatedboolean nullable

Was the facade insulated after construction?

isRoofInsulatedboolean nullable

Was the roof insulated after construction?

pipeSystemType'singlePipeHeating' | 'twoPipeHeating' | 'unknown'
roomHeatingType'floor' | 'floorAndRadiator' | 'radiator'
averageEnergyConsumptionLast3Yearsnumber nullable

Average energy consumption over the last 3 years (kWh or liters depending on system)

hasSolarThermalSystemboolean nullable

Whether the property has a solar thermal system

hasFireplaceboolean nullable

Whether the property has a wood-burning fireplace

windowGlazingType'single' | 'double' | 'triple' | 'doubleWithThermalInsulation' | 'tripleWithThermalInsulation'
responsibleProfileIdstring uuid nullable

Profile ID of the team member responsible for this project. Pass null on PATCH to clear.

tagsstring[]

Tag names. Replaces all existing tags on create/update; pass an empty array to clear.

Example request

{
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 101",
    "postalCode": "12047",
    "city": "Berlin",
    "country": "Deutschland",
    "countryCode": "DE",
    "latitude": 48.6964906,
    "longitude": 13.2635728
  }
}

Response

OK

idstring uuid
namestring
companyIdstring uuid
currentStageIdstring uuid nullable

The ID of the project stage. Use the /project-stages endpoint to list available stages.

hubspotDealIdstring nullable

HubSpot deal ID when this project is linked to a deal in HubSpot. Omitted when not linked.

createdAtstring date-time
updatedAtstring date-time
avgHeatloadnumber nullable

Average heat load per m² (W/m²). Computed; not accepted in request body.

yearlyEnergyConsumptionnumber nullable

Estimated yearly energy consumption (kWh). Computed; not accepted in request body.

technicalFeasibilityAssesment'feasible' | 'notFeasible' | 'notStarted'
source'internal' | 'hubspot' | 'check' | 'hero' | 'marketplace' | 'zapier' | 'api' | 'leadEmail' | 'leadFinder' | 'pipedrive'
responsibleProfileIdstring uuid nullable

Profile ID of the team member responsible for this project. Pass null on PATCH to clear.

tagsstring[]

Tag names. Replaces all existing tags on create/update; pass an empty array to clear.

customerIdstring uuid nullable
status'inProgress' | 'completed' | 'archived'
isLeadboolean nullable

Determines if the project is a lead project

humanIdstring nullable

Human readable identifier. E.g. "P-001"

projectValuenumber float nullable

The value of the project. E.g. 10.000EUR

installationDatestring date nullable
buildingType'singleOrDoubleFamilyHouse' | 'semiDetachedHouse' | 'terracedHouse' | 'endTerracedHouse' | 'multiFamilyHouse' | 'commercialBuilding'
buildingAge'from2002' | 'from1995To2001' | 'from1984To1994' | 'from1979To1983' | 'from1969To1978' | 'from1958To1968' | 'from1949To1957' | 'from1919To1948' | 'before1918'
isMonumentProtectedboolean

Determines if the building is monument protected

numberOfResidentsnumber nullable

The number of residents in the building

numberOfFloorsnumber nullable

The number of floors in the building

heatedLivingAreaM2number nullable

The heated living area in square meters. Used in the heat pump check. This is an independent value and not the total sum of room areas.

currentHeatingSystemType'gas' | 'oil' | 'condensingGas' | 'condensingOil' | 'pellet' | 'electric' | 'districtOrOther'
currentHeatingSystemConstructionYear'before1980' | 'between1980And1995' | 'after1995'
drinkingWaterHeatingSystemType'withCirculation' | 'withoutCirculation'
isFacadeInsulatedboolean nullable

Was the facade insulated after construction?

isRoofInsulatedboolean nullable

Was the roof insulated after construction?

pipeSystemType'singlePipeHeating' | 'twoPipeHeating' | 'unknown'
roomHeatingType'floor' | 'floorAndRadiator' | 'radiator'
averageEnergyConsumptionLast3Yearsnumber nullable

Average energy consumption over the last 3 years (kWh or liters depending on system)

hasSolarThermalSystemboolean nullable

Whether the property has a solar thermal system

hasFireplaceboolean nullable

Whether the property has a wood-burning fireplace

windowGlazingType'single' | 'double' | 'triple' | 'doubleWithThermalInsulation' | 'tripleWithThermalInsulation'

Example response

{
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 101",
    "postalCode": "12047",
    "city": "Berlin",
    "country": "Deutschland",
    "countryCode": "DE",
    "latitude": 48.6964906,
    "longitude": 13.2635728
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.