V2 API overview
The management API. Read and write an account's properties, inventory, content, media, groups, connections, users and website content entries.
OpenAPI specification for the /api/v2 Laravel API. Resource routes require a Sanctum bearer token scoped to an account: an account API token. Website delivery and preview tokens cannot call this API and get a 403. Every account-scoped route runs against the token's account by default; a user with access to more than one account can direct a single request at another of their accounts with the optional account_id parameter (query string, or JSON body on writes) — for example listing properties for a specific account, or creating a property or connection under it. The account a request resolved to is returned on the X-Resi-Account-Id response header. Every path identifier is a UUID, except a fee assignment's integer id; a value that is not in the expected form is a 404. Slug addressing is available only on the V1 connection-scoped portfolio routes, where the slug is resolved against a single portfolio. Create and update payloads are JSON bodies. Media is imported by URL — POST /api/v2/media for one item, POST /api/v2/media/batch for up to 100 — and Resi downloads and stores each file; uploading a binary body is not supported. Imports deduplicate, so re-running the same import is safe (see the Media tag for the dedup keys).
Guides
- Getting started and Authentication
- Core concepts
- Pagination, filtering and sorting
- Errors, rate limits and reliability
- Users and roles
- Syncing inventory
- Media
- Groups
- Website content entries
- Managing connections
The V2 API reference lists every endpoint. The OpenAPI document is at /openapi/v2.json.
Last updated on