resi_get_current_user
Get current user and accounts
Return the Resi user who owns this token and every account that user belongs to. The token itself is pinned to one account: use resi_get_token_account to see which one. Resi API: GET /api/v2/me.
无需输入参数。
resi_get_token_account
Get the account this token is pinned to
Return the id of the Resi account this token runs against (the X-Resi-Account-Id response header) and the property count there. Use it to confirm which client a token serves. Resi API: GET /api/v2/properties?per_page=1.
无需输入参数。
resi_list_properties
List properties
List the properties (communities) in the token's account, with address, contact details and status. Start here to find a property id. Resi API: GET /api/v2/properties. Properties cannot be sorted.
输入参数pagegroupper_page
resi_get_property
Get property
Return one property with its address, settings and contact details. Resi API: GET /api/v2/properties/{property}.
输入参数property_id必填
resi_list_buildings
List buildings
List the buildings of a property (filter by property_id). Resi API: GET /api/v2/buildings.
输入参数namepagegroupper_pageproperty_id
resi_list_floor_plans
List floor plans
List floor plans with bedroom range, size and rent range. Filter by property_id, name or bedroom count. Resi API: GET /api/v2/floor-plans.
输入参数namepagegroupper_pageis_enabledproperty_idmax_bedroomsmin_bedrooms
resi_list_units
List units
List apartment units with rent, availability and bedrooms. Use is_available=true and a rent range to answer 'what can I rent'. Filters run on Resi, which saves quota. Resi API: GET /api/v2/units.
输入参数pagesortgroupnumbermax_rentmin_rentper_pageis_hiddenbuilding_idproperty_idavailable_byis_available另有 4 个
Return one unit with its property, building, floor plan, amenities, fee breakdown and synced_fields (fields a PMS connection overwrites). Resi API: GET /api/v2/units/{unit}.
输入参数unit_id必填
resi_update_unit
Update unit availability or price
WRITE: change one unit's availability, availability date, rent, deposit, specials or description. Changes go live on the client's Resi sites. A field listed in the unit's synced_fields is overwritten by the next PMS sync. Pass only the fields to change. min_rent and max_rent are total monthly leasing prices (base rent plus mandatory fees). Resi API: PATCH /api/v2/units/{unit}. Needs a full-access token.
输入参数depositunit_id必填max_rentmin_rentspecialsis_hiddendescriptionavailable_atis_available
resi_list_amenities
List amenities
List amenities (pool, gym, pet policy items and so on) with their codes and marketing flags. Resi API: GET /api/v2/amenities.
输入参数namepageper_pageproperty_id
List fees (application, admin, pet, utility and so on) with their class, currency and status. Resi API: GET /api/v2/fees.
输入参数namepageper_pageproperty_id
resi_list_reviews
List reviews
List resident and public reviews of a property, with rating, source and publish state. Resi API: GET /api/v2/reviews.
输入参数pageper_pageproperty_idis_published
resi_list_leads
List leads
List leads (prospect contact forms and tour bookings), newest first. Poll for new leads with created_after set to the newest created_at you hold. Contains personal data: use only for the client's own leasing work. Resi API: GET /api/v2/leads.
输入参数pageemailform_idper_pageproperty_idconnection_idcreated_aftercreated_beforelead_source_id
Return one lead with its contact fields, tour booking, lead source and full submission. Resi API: GET /api/v2/leads/{lead}.
输入参数lead_id必填
resi_list_lead_sources
List lead sources
List lead sources (where a lead came from, e.g. Zillow or the website) for attribution. Resi API: GET /api/v2/lead-sources.
输入参数namepageper_pageproperty_id
resi_list_media
List media
List photos, floor plans, PDFs (kind=file) or videos and virtual tours (kind=embed). One kind per call. Filter by the parent record. Resi API: GET /api/v2/media.
输入参数tagkind必填pageper_pageattachable_idattachable_type
resi_list_connections
List connections
List PMS and CRM connections (the syncs that feed inventory and leads), with type, category and enabled state. Resi API: GET /api/v2/connections.
输入参数namepageenabledper_pageproperty_id
resi_list_connection_logs
List connection logs
List the sync and import runs of one connection, newest first, with status and error message. Use it to find why a sync failed. Logs are kept 14 days. Resi API: GET /api/v2/connections/{connection}/logs.
输入参数pagestatusper_pageevent_typeproperty_idconnection_id必填created_after
resi_list_users
List users
List the users of the account (staff and service users) with their role. Resi API: GET /api/v2/users.
输入参数namepageroleemailper_page