Which API should I use?
Resi has three APIs for three different jobs. Pick by what you are building.
Resi's three APIs are not three versions of the same thing. Each one serves a different job, and many integrations use two of them.
| V2 | V1 | Sites | |
|---|---|---|---|
| Job | Manage data | Deliver a property's public content | Deliver a website's content |
| Base path | /api/v2 | /api/v1 | /api/sites/v1 |
| Auth | Bearer token, per account | None | Bearer token, per website |
| Scoped to | One account | One property (by UUID) | One website |
| Called from | Your server | A browser or your server | The website's server only |
| Addressing | UUIDs | UUIDs | Slugs |
| Reads and writes | Full create, read, update and delete | Reads, plus public lead, tour and analytics writes | Reads, plus form, tour and analytics writes |
All three are served from https://v2.getresi.com.
Pick by what you are building
An integration that reads or changes an account's data, such as an ILS feed, a CRM sync, a BI export or a portfolio onboarding tool: use V2. It covers properties, buildings, floor plans, units, fees, media, content, groups, connections, users, and the content entries on an account's websites. Start with Getting started and Authentication.
A new server-rendered property or leasing website, such as one built on Next.js: use the Sites API. One token reads everything a website renders, scoped to that website, addressed by slug, with cache tags and a cache-clear webhook so pages stay fresh without polling.
A WordPress site, a widget, or a browser form that needs one property's public content without a credential: use V1. It also takes public lead submissions and tour bookings.
The Sites API token reads data that is not public and can create leads. Keep it on the server. If a browser has to call Resi directly, that call belongs on V1.
Common combinations
- V2 + V1: a vendor syncs inventory through V2 and submits leads or books tours from a public form through V1.
- Sites + V2: a website renders from the Sites API while a back-office tool manages the same account's data through V2.
Last updated on