Docs
V2 API

V2 API reference

Every V2 endpoint, generated from the OpenAPI document at /openapi/v2.json.

Endpoints

Auth

The authenticated user, and the account-scoped API tokens that call this API.

EndpointSummary
GET /api/v2/meGet the authenticated user and accounts
GET /api/v2/tokensList account API tokens
POST /api/v2/tokensCreate an account-scoped API token
DELETE /api/v2/tokens/{tokenId}Revoke an account API token

Properties

Properties in the account: create, read, update and delete.

EndpointSummary
GET /api/v2/propertiesList properties
POST /api/v2/propertiesCreate property
GET /api/v2/properties/{property}Get property
PATCH /api/v2/properties/{property}Update property
DELETE /api/v2/properties/{property}Delete property

Buildings

Buildings within a property.

EndpointSummary
GET /api/v2/buildingsList buildings
POST /api/v2/buildingsCreate building
GET /api/v2/buildings/{building}Get building
PATCH /api/v2/buildings/{building}Update building
DELETE /api/v2/buildings/{building}Delete building

Floor Plans

Floor plans within a property.

EndpointSummary
GET /api/v2/floor-plansList floor plans
POST /api/v2/floor-plansCreate floor plan
GET /api/v2/floor-plans/{floor_plan}Get floor plan
PATCH /api/v2/floor-plans/{floor_plan}Update floor plan
DELETE /api/v2/floor-plans/{floor_plan}Delete floor plan

Units

Units within a property, each optionally tied to a floor plan and building.

EndpointSummary
GET /api/v2/unitsList units
POST /api/v2/unitsCreate unit
GET /api/v2/units/{unit}Get unit
PATCH /api/v2/units/{unit}Update unit
DELETE /api/v2/units/{unit}Delete unit

Amenities

Amenities attached to properties, floor plans or units.

EndpointSummary
GET /api/v2/amenitiesList amenities
POST /api/v2/amenitiesCreate amenity
GET /api/v2/amenities/{amenity}Get amenity
PATCH /api/v2/amenities/{amenity}Update amenity
DELETE /api/v2/amenities/{amenity}Delete amenity

Fees

The account fee library. Fees are assigned to properties and feed pricing.

EndpointSummary
GET /api/v2/feesList fees
POST /api/v2/feesCreate fee
GET /api/v2/fees/{fee}Get fee
PATCH /api/v2/fees/{fee}Update fee
DELETE /api/v2/fees/{fee}Delete fee
GET /api/v2/fee-assignmentsList fee assignments
POST /api/v2/fee-assignmentsCreate fee assignment
GET /api/v2/fee-assignments/{fee_assignment}Get fee assignment
PATCH /api/v2/fee-assignments/{fee_assignment}Update fee assignment
DELETE /api/v2/fee-assignments/{fee_assignment}Delete fee assignment

Reviews

Property reviews, with their rating, source and any reply.

EndpointSummary
GET /api/v2/reviewsList reviews
POST /api/v2/reviewsCreate review
GET /api/v2/reviews/{review}Get review
PATCH /api/v2/reviews/{review}Update review
DELETE /api/v2/reviews/{review}Delete review

Announcements

Announcements shown on property websites, optionally scheduled with a start and end date. Each is global or assigned to properties.

EndpointSummary
GET /api/v2/announcementsList announcements
POST /api/v2/announcementsCreate announcement
GET /api/v2/announcements/{announcement}Get announcement
PATCH /api/v2/announcements/{announcement}Update announcement
DELETE /api/v2/announcements/{announcement}Delete announcement

Content Blocks

Blocks of marketing copy for property websites. Each is global or assigned to properties.

EndpointSummary
GET /api/v2/content-blocksList content blocks
POST /api/v2/content-blocksCreate content block
GET /api/v2/content-blocks/{content_block}Get content block
PATCH /api/v2/content-blocks/{content_block}Update content block
DELETE /api/v2/content-blocks/{content_block}Delete content block

FAQs

Frequently asked questions shown on property websites.

EndpointSummary
GET /api/v2/faqsList FAQs
POST /api/v2/faqsCreate FAQ
GET /api/v2/faqs/{faq}Get FAQ
PATCH /api/v2/faqs/{faq}Update FAQ
DELETE /api/v2/faqs/{faq}Delete FAQ

Galleries

Named collections of media. Each is global or assigned to properties.

EndpointSummary
GET /api/v2/galleriesList galleries
POST /api/v2/galleriesCreate gallery
GET /api/v2/galleries/{gallery}Get gallery
PATCH /api/v2/galleries/{gallery}Update gallery
DELETE /api/v2/galleries/{gallery}Delete gallery

Neighborhood Categories

Account-wide categories that neighborhood places are filed under. Managing them requires the account Admin role (staff qualify). Every account created — in the admin panel or with POST /api/v2/accounts — starts with nine default categories: Bars, Coffee, Groceries, Personal Care, Public Transit, Restaurants, Schools, Shopping, Activities. They carry sort_order 0 and so list alphabetically until reordered. Categories have no enabled flag: a category with no places simply does not render.

EndpointSummary
GET /api/v2/neighborhood-categoriesList neighborhood categories
POST /api/v2/neighborhood-categoriesCreate neighborhood category
GET /api/v2/neighborhood-categories/{neighborhood_category}Get neighborhood category
PATCH /api/v2/neighborhood-categories/{neighborhood_category}Update neighborhood category
DELETE /api/v2/neighborhood-categories/{neighborhood_category}Delete neighborhood category

Neighborhood Places

Points of interest near a property, filed under a neighborhood category.

EndpointSummary
GET /api/v2/neighborhood-placesList neighborhood places
POST /api/v2/neighborhood-placesCreate neighborhood place
GET /api/v2/neighborhood-places/{neighborhood_place}Get neighborhood place
PATCH /api/v2/neighborhood-places/{neighborhood_place}Update neighborhood place
DELETE /api/v2/neighborhood-places/{neighborhood_place}Delete neighborhood place

Media

Media is imported by URL; Resi downloads and stores files, and stores embeds (videos, virtual tours) as links. Imports are idempotent. A file deduplicates within the account on its source url first and its reference_id second: a match re-attaches the existing asset to the parent (slot and sort_order updated) instead of downloading again, and caption, alt_text and tags on the existing asset are left as they are (change them with PATCH /api/v2/media/{media}). A reference_id match whose url differs replaces the stored file with the new download. An embed deduplicates on parent + embed_type + url: a repeat updates that embed's title, provider, settings, tags and sort_order rather than adding a copy. Give each file a stable reference_id (for example the source system's image id) so a changed CDN url still lands on the same asset.

EndpointSummary
GET /api/v2/mediaList media
POST /api/v2/mediaImport media
GET /api/v2/media/{media}Get media
PATCH /api/v2/media/{media}Update media
DELETE /api/v2/media/{media}Delete media
POST /api/v2/media/batchImport media in bulk
PATCH /api/v2/media/{media}/attachments/{attachableType}/{attachableId}Re-order a file on a record
DELETE /api/v2/media/{media}/attachments/{attachableType}/{attachableId}Remove a file from a record
GET /api/v2/media-foldersList media folders
POST /api/v2/media-foldersCreate media folder

Accounts

The accounts the authenticated user belongs to.

EndpointSummary
GET /api/v2/accountsList accounts
POST /api/v2/accountsCreate account
GET /api/v2/accounts/{account}Get account

Connections

Integrations with external systems (PMS, CRM and others), the properties they cover, and on-demand sync runs.

EndpointSummary
GET /api/v2/connectionsList connections
POST /api/v2/connectionsCreate connection
GET /api/v2/connections/{connection}Get connection
PATCH /api/v2/connections/{connection}Update connection
DELETE /api/v2/connections/{connection}Delete connection
POST /api/v2/connections/{connection}/runRun connection
POST /api/v2/connections/{connection}/propertiesAttach property to connection
DELETE /api/v2/connections/{connection}/properties/{propertyId}Detach property from connection
GET /api/v2/connections/{connection}/logsList connection logs

Users

Users in the account.

EndpointSummary
GET /api/v2/usersList users
POST /api/v2/usersCreate user
GET /api/v2/users/{user}Get user
PATCH /api/v2/users/{user}Update user
DELETE /api/v2/users/{user}Remove user from account
GET /api/v2/rolesList roles
GET /api/v2/roles/{role}Get role

Lead Sources

The lead sources that attribute where a lead came from.

EndpointSummary
GET /api/v2/lead-sourcesList lead sources
POST /api/v2/lead-sourcesCreate lead source
GET /api/v2/lead-sources/{lead_source}Get lead source
PATCH /api/v2/lead-sources/{lead_source}Update lead source

Property Settings

A property's settings in one read: attributes, connections, domain settings and fees.

EndpointSummary
GET /api/v2/properties/{property}/settingsGet property settings

Instagram

The Instagram feed of a property with a connected Instagram account.

EndpointSummary
GET /api/v2/properties/{property}/instagram-feedProperty Instagram feed
GET /api/v2/properties/{property}/social-profilesGet social profiles

Groups

Group sets and the groups in them: how properties, buildings, floor plans and units are organised, and the group filter on every inventory list.

EndpointSummary
GET /api/v2/group-setsList group sets
POST /api/v2/group-setsCreate group set
GET /api/v2/group-sets/{group_set}Get group set
PATCH /api/v2/group-sets/{group_set}Update group set
DELETE /api/v2/group-sets/{group_set}Delete group set
GET /api/v2/groupsList groups
POST /api/v2/groupsCreate group
GET /api/v2/groups/{group}Get group
PATCH /api/v2/groups/{group}Update group
DELETE /api/v2/groups/{group}Delete group
POST /api/v2/groups/{group}/membersAdd group member
DELETE /api/v2/groups/{group}/members/{memberId}Remove group member

Websites

The account's websites, the content types each carries, and their content entries. Websites and content types are read-only here; entries are writable.

EndpointSummary
GET /api/v2/websitesList websites
GET /api/v2/websites/{website}Get website
GET /api/v2/websites/{website}/content-typesList website content types
GET /api/v2/websites/{website}/content-types/{contentType}Get website content type
GET /api/v2/websites/{website}/content-types/{contentType}/entriesList content entries
POST /api/v2/websites/{website}/content-types/{contentType}/entriesCreate content entry
GET /api/v2/websites/{website}/content-types/{contentType}/entries/{entry}Get content entry
PATCH /api/v2/websites/{website}/content-types/{contentType}/entries/{entry}Update content entry
DELETE /api/v2/websites/{website}/content-types/{contentType}/entries/{entry}Delete content entry

Leads

Leads: form submissions and tour bookings. Read-only; leads arrive through websites and the public APIs.

EndpointSummary
GET /api/v2/leadsList leads
GET /api/v2/leads/{lead}Get lead

Last updated on

V2 API overview

The management API. Read and write an account's properties, inventory, content, media, groups, connections, users and website content entries.

Get the authenticated user and accounts GET

Next Page