Husvo

API-referens

Export

Allt om huset som zip, journalen som pdf och csv.

Allt som finns i huset som en zip: uppgifter, bilder, manualer, protokoll och journal. Bara ägaren

GET /api/v1/houses/{houseId}/export.zip

operationId exportHouse

  • Bearer-token
  • Kräver att du får ta ut husets data
  • Skrivtaket gäller

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Exempel

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

Svar

200 Klart · application/zip

Svaret är filen själv.

Fel, som problem+json (felkoderna):

  • 403Inte tillåtet
  • 404Finns inte, eller inte för dig

Journalen som pdf, att ge till mäklaren eller nästa ägare. Alla medlemmar

GET /api/v1/houses/{houseId}/journal.pdf

operationId exportJournal

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

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Exempel

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

Svar

200 Klart · application/pdf

Svaret är filen själv.

Fel, som problem+json (felkoderna):

  • 403Inte tillåtet
  • 404Finns inte, eller inte för dig

Journalen som csv för Excel eller Numbers, samma fil som webben ger. Alla medlemmar

GET /api/v1/houses/{houseId}/journal.csv

operationId exportJournalCsv

  • 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/journal.csv" \
  -H "Authorization: Bearer $TOKEN"

Svar

200 Klart · text/csv

Svaret är filen själv.

Fel, som problem+json (felkoderna):

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