Overview

Havnly API

Place people in temporary housing from your own system.

The API covers the whole placement: submit a housing request, see the homes that match it, put one on the request, set the move-in dates, and follow the lease through to a confirmed booking. Everything your team would do in Havnly, without opening Havnly.

https://api.havnly.ai/functions/v1

What a placement looks like

  1. Submit a request — where the household needs to live, for how long, on what budget.
  2. Read the matches — verified homes inside the request’s radius and budget.
  3. Put a home on the request — send it to the household to choose, or place it directly when they are not on Havnly.
  4. Set the move-in dates — this reserves the home’s calendar and sends the lease for signature on its own.
  5. Signatures — the tenant (or whoever you name) signs, the landlord countersigns.
  6. Payment — completed in Havnly by the paying party, because the money moves on the landlord’s own Stripe account.
  7. Booked — the stay is confirmed and the placement is live.

Steps 1 to 5 are API calls. Steps 6 and 7 you watch through webhooks.

Two things worth knowing early

Signing happens in a browser. A lease is a document a person signs. The API creates it and emails a link; nobody signs over HTTP.

Payment happens in Havnly. Rent is charged directly on the landlord’s connected Stripe account — Havnly never holds the money. Taking card details through this API would put your systems inside PCI scope for a payment that isn’t ours to take, so the paying party completes it in the app.

Everything else — intake, matching, placing, dates, contract, status — is yours to drive.

Start here

Quickstart