Husvo

API-referens

Husen

Husen du är med i, ett hus i taget, dagens läge och husets inställningar.

Husen jag är med i, med min roll i vart och ett

GET /api/v1/houses

operationId listHouses

  • Bearer-token

Exempel

curl -X GET "https://husvo.app/api/v1/houses" \
  -H "Authorization: Bearer $TOKEN"

Svar

200 Klart · HouseListResponse
{
  "items": [
    {
      "id": 1,
      "name": "text",
      "houseType": "text",
      "year": 2026,
      "budgetPerYearTkr": 1,
      "reminderLeadDays": 1,
      "role": "text",
      "features": {
        "ventilation": "text",
        "heating": "text",
        "foundation": "text",
        "roof": "text",
        "water": "text",
        "sewage": "text",
        "fireplace": false,
        "poolOrSpa": false,
        "facade": "text",
        "garage": "text",
        "deck": false,
        "hedge": false,
        "attic": false,
        "balcony": false,
        "has": [
          "text"
        ],
        "hasNot": [
          "text"
        ],
        "tenure": "text"
      }
    }
  ]
}

Fel, som problem+json (felkoderna):

  • 401Inte inloggad

Ett hus: profil, budget och påminnelsetid

GET /api/v1/houses/{houseId}

operationId getHouse

  • Bearer-token
  • Kräver läsrätt i huset

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Exempel

curl -X GET "https://husvo.app/api/v1/houses/1" \
  -H "Authorization: Bearer $TOKEN"

Svar

200 Klart · HouseDto
{
  "id": 1,
  "name": "text",
  "houseType": "text",
  "year": 2026,
  "budgetPerYearTkr": 1,
  "reminderLeadDays": 1,
  "role": "text",
  "features": {
    "ventilation": "text",
    "heating": "text",
    "foundation": "text",
    "roof": "text",
    "water": "text",
    "sewage": "text",
    "fireplace": false,
    "poolOrSpa": false,
    "facade": "text",
    "garage": "text",
    "deck": false,
    "hedge": false,
    "attic": false,
    "balcony": false,
    "has": [
      "text"
    ],
    "hasNot": [
      "text"
    ],
    "tenure": "text"
  }
}

Fel, som problem+json (felkoderna):

  • 404Finns inte, eller inte för dig

Ändra husets namn, hur många dagar före påminnelsen går och på vilket sätt, och vad huset har

PATCH /api/v1/houses/{houseId}

operationId updateHouse

  • Bearer-token
  • Kräver redigeringsrätt i huset
  • Skrivtaket gäller

I features sätter has saker till ja, hasNot till nej och unknown tillbaka till vet ej, med samma namn som getHouse ger. Det som inte skickas lämnas orört. Namnen: sauna, woodFiredSauna, jetty, dryToilet, generator, privateRoad, solarPanels, homeBattery, evCharger, alarm, gasGrill, airToAirHeatPump, underfloorHeating, dehumidifier, leakDetector, sumpPit, waterTreatment, bathtub, skylights, flatRoof, snowGuards, heatingCable, glazedEnclosure, multipleFloors, robotMower, robotVacuum, snowBlower, fence, playEquipment, greenhouse, basementStairs, smartLock, woodFloors, emptyInWinter. heating: districtHeating, groundSource, airToWater, directElectric, pellets, electricBoiler, oilBoiler eller unknown. tenure: ownership, cooperative, rental eller unknown.

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Kropp application/json · HousePatchBody

FältTypKrävs
name string nej
reminderLeadDays integer nej
reminderChannel string nej
features HouseFeaturesPatchBody nej
{
  "name": "text",
  "reminderLeadDays": 1,
  "reminderChannel": "text",
  "features": {
    "has": [
      "text"
    ],
    "hasNot": [
      "text"
    ],
    "unknown": [
      "text"
    ],
    "heating": "text",
    "tenure": "text"
  }
}

Exempel

curl -X PATCH "https://husvo.app/api/v1/houses/1" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"text","reminderLeadDays":1,"reminderChannel":"text","features":{"has":["text"],"hasNot":["text"],"unknown":["text"],"heating":"text","tenure":"text"}}'

Svar

200 Klart · HouseDto
{
  "id": 1,
  "name": "text",
  "houseType": "text",
  "year": 2026,
  "budgetPerYearTkr": 1,
  "reminderLeadDays": 1,
  "role": "text",
  "features": {
    "ventilation": "text",
    "heating": "text",
    "foundation": "text",
    "roof": "text",
    "water": "text",
    "sewage": "text",
    "fireplace": false,
    "poolOrSpa": false,
    "facade": "text",
    "garage": "text",
    "deck": false,
    "hedge": false,
    "attic": false,
    "balcony": false,
    "has": [
      "text"
    ],
    "hasNot": [
      "text"
    ],
    "tenure": "text"
  }
}

Fel, som problem+json (felkoderna):

  • 403Inte tillåtet
  • 422Kontrollera uppgifterna

Startsidan: försenat, snart, räknare, nästa punkter och husets humör

GET /api/v1/houses/{houseId}/today

operationId getToday

  • Bearer-token
  • Kräver läsrätt i huset

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Exempel

curl -X GET "https://husvo.app/api/v1/houses/1/today" \
  -H "Authorization: Bearer $TOKEN"

Svar

200 Klart · TodayResponse
{
  "houseId": 1,
  "houseName": "text",
  "today": "2026-11-13",
  "mood": "text",
  "counts": {
    "overdue": 1,
    "soon": 1,
    "scheduled": 1,
    "unscheduled": 1,
    "rooms": 1,
    "ideas": 1,
    "plannedIdeas": 1,
    "unreadActivity": 1
  },
  "next": [
    {
      "id": 1,
      "name": "text",
      "intervalLabel": "text",
      "state": "text",
      "daysLeft": 1,
      "nextDueAt": "2026-11-13"
    }
  ],
  "lastDoneOn": "2026-11-13"
}

Fel, som problem+json (felkoderna):

  • 404Finns inte, eller inte för dig
Sidan hakade upp sig.Ladda om🗙