MyRemotely API

Read-only access to the records of the organization authenticated by x-api-key.

OpenAPI 3.2.1 · API 1.0.0

List blackout days of a unit

GET /v1/units/list_showing_blackouts

List the blackout ranges of one Unit, by its urlKey: the days no Tour can be booked. Returns current and future ranges only, soonest first, each with id, start and end date (both included) and reason. Requires units:write.

Preview a unit timezone change

GET /v1/units/preview_timezone_change

Preview a timezone change for one Unit, by its id or urlKey: every future Tour, Code, open house and scheduled message it would move, before and after, under both policies. Changes nothing; pass the returned expectedVersion to units.set_timezone. Requires units:write.

Get the pre-screening of a unit

GET /v1/units/get_prescreening_context

Read the pre-screening that applies to one Unit, by urlKey or id: the Unit's own questions and rules (override) and the org default, each null when unset or not valid. The override wins when both are set. Requires units:write.

Count open-house RSVPs

GET /v1/units/get_open_house_rsvp_count

Count the live RSVPs for the open house on one Unit, by urlKey or id. An open house has no seat limit, so capacityRemaining is always null. Returns zero RSVPs when no open house is set. Requires units:write.

List open-house hosts

GET /v1/units/list_open_house_host_candidates

List the Users of the caller's org who can host an open house (everyone who accepted their invite), by name, with id, name and email. Pass an id as hostUserId to units.set_open_house_window. Requires units:write.

List lock brands

GET /v1/locks/list_brands

List the Lock brands of the caller's org by name, each with id, name, dates and how many Locks use it. Changes nothing; to add one, use locks.create_brand. Requires locks:read.

List lock connectors

GET /v1/locks/list_connectors

List the active Lock connectors (for example TTLock) by name, with slug, status, capabilities and logo. The list is the same for every org, and reading it changes nothing. Requires locks:read.

List the codes an unbind could revoke

GET /v1/locks/list_revocable_codes

List every active Code on one Lock by id, name and type, marking the ones added by hand, so an unbind can choose what to revoke. Never returns the Code digits. Changes nothing. Requires locks:assign.

List locks

GET /v1/locks

Lists active locks owned by the API key organization in stable cursor order. Requires locks:read.

Get a lock

GET /v1/locks/{lockId}

Gets one active lock owned by the API key organization. Requires locks:read.

Get live lock state

GET /v1/locks/{lockId}/state

Reads the provider live state for one active lock. Requires locks:read.

Read the day-code runway of a lock

GET /v1/passcodes/read_lock_runway

Read how many days ahead one Lock holds DAY Codes for each listed Unit, with the planned horizon, capacity and live Code count. A Lock with no vendor id or no listed Unit answers not measurable, with the reason. Carries no Code digits. Requires locks:read.

Read how a unit code update went

GET /v1/passcodes/read_unit_code_status

Read whether the last door-code update of one Unit reached its Locks: queued, running or settled, success or failed, Codes in place of planned, the Locks that failed and why, and the org's Code horizon. Unknown when no recent run is on record. Carries no Code digits. Requires locks:write.

List the times a tour can move to

GET /v1/tours/list_reschedule_slots

List the free start times a Tour can move to in the next 14 days. Returns each slot's start, end and label, plus the Unit's timezone. Uses the Unit's hours, notice and blocked days and counts the Tour's own time as free; a Tour with no Unit gets no slots (no_unit). Requires tours:write.

Get an inquiry

GET /v1/inquiries/get

Read one Inquiry by id: Prospect name, phone and email, address, Unit id, source, comment, status, time and pre-screening answers. Sees any Inquiry in the caller's org; find the id with inquiries.list. Requires inquiries:read.

Count unread incoming messages

GET /v1/messages/count_unread

Count unread incoming messages and events across all Prospect conversations in the caller's org and return unreadCount. Takes no input and counts the whole org. For counts per conversation, use messages.list_conversations. Requires messages:read.

List the latest calls

GET /v1/phone/list_calls

List the 50 latest phone calls in the caller's org, newest first, each with id, direction, outcome, number, Prospect name, time, duration, source and operator name. Optional search on phone, Prospect name or team member name, and an optional direction (inbound or outbound); test-lab calls are left out. Open one with phone.get_voice_call. Requires phone:call.

List users

GET /v1/users/list_users

List Users with email, role, Org, alert phone, invite state and owned-Unit count, newest first. Filter by role name or search name and email; 20 results at a time by default, up to 500. Only the caller's Org; a super-admin sees every Org. Requires users:read.

Get a user

GET /v1/users/get_user

Read one User by id: name, email, alert phone, email-verified flag, role with its permissions, Org, and dates. Only Users of the caller's Org; a super-admin can read any Org. Get the id from users.list_users. Requires users:read.

List every permission

GET /v1/roles/list_permissions

List every permission a role can hold, each with id, name, display name and category, also grouped by category. Only a super-admin sees the cross-Org permissions. Use the ids with roles.create_role or roles.update_role. Requires users:read.

List roles

GET /v1/roles/list_roles

List roles with their permissions and the count of Users on each, system roles first. The caller sees system roles and their own Org's custom roles, with super-admin roles hidden; a super-admin sees the roles of every Org. Requires users:read.

Get a role

GET /v1/roles/get_role

Read one role by id with its permissions and the count of Users who hold it. The caller can read system roles and roles of their own Org; a super-admin can read any. Get the id from roles.list_roles. Requires users:read.

Get inbound call routing

GET /v1/settings/get_voice_routing

Read how the Org routes inbound calls: whether the team's browsers ring first, how many seconds they ring before Remo answers, and whether Remo may hand a live call to the team. Returns the defaults when the Org has saved nothing. Requires settings:write.

Get the default pre-screening

GET /v1/settings/get_default_prescreening

Read the Org's default pre-screening config: the questions (id, type, label, options) and pass/fail rules a Prospect answers before booking a Tour from a public listing. Returns null when none is set or the stored value is invalid. A Unit's own override wins over it. Requires settings:read.

List saved message templates

GET /v1/templates/list_message_templates

List the Org's saved message templates (reusable SMS replies), by sort order then name: id, name, body, sort order and times. No paging. Automated SMS texts are not included; for those, use templates.list_automated_message_templates. Requires messages:read.

Get a saved message template

GET /v1/templates/get_message_template

Read one saved message template: id, name, body with its {{variables}}, sort order, created and updated times. Needs a template id from templates.list_message_templates, in the caller's Org. Requires messages:read.

List automated message texts

GET /v1/templates/list_automated_message_templates

List the Org's four automated SMS messages (first Inquiry reply, post-Tour follow-up, missed-Tour follow-up, Tour access-code SMS): key, label, trigger, current body, allowed variables and whether the Org changed it. Unchanged ones show the built-in text. Requires messages:read.

List tour access-code texts

GET /v1/templates/list_tour_message_templates

List the Tour access-code SMS texts: the Org default and one entry per Lock brand, each with the body sent today, whether it is custom, and when it changed. Without a custom text, the built-in default shows. Requires locks:read.

Get this month's usage

GET /v1/billing/get_usage

List this month's billable usage: one row per day with the count of Units on market and its amount, and one row per signed Rentvine lease with address, tenant, date and fee. Takes no input; covers the current UTC calendar month only. For totals, use billing.get_status. Requires settings:read.

Get the listing switches

GET /v1/integrations/get_public_listings_flag_state

Read whether the Org's public listings are on and the count of on-market Units with a public listing. Changes nothing. To change it, use integrations.set_public_listings_active. Requires settings:read.