Search
K
Viewing Appointments

Viewing Appointments

1.0.0OAS 3.0

Schedules individual and group viewings, manages confirmations and
cancellations, and collects feedback after the appointment.

The API supports two models: fixed appointments, to which you invite
leads, and availability windows, from which leads pick their own slot.
Both can be mixed per property.

API Base URL
  • Server 1:https://api.realestateagency.example/v1

    Production

  • Server 2:https://sandbox.api.realestateagency.example/v1

    Sandbox

Security
apiKey (apiKey)

Every call carries an API key in the apikey header. You generate the
key in the Real Estate portal under “My Apps”; it’s shown exactly once.

Each key has the scopes it’s allowed to use attached to it. If one is
missing, the API responds with 403 and code: "scope_missing"; the
missing scope is in details[].field.

Additional Information
Contact API Support - Real Estate Agency (api-support@realestateagency.example)

Appointments

List appointments

get

Query Parameters

property_idstring

Example:prop_8f2c1a

fromstring(date-time)
tostring(date-time)
statusstring

Allowed values:scheduledconfirmedcompletedcancelled

Example:confirmed

Response

application/json

Results list

dataarray
Show Child Parameters
pageobject

Cursor-based pagination.

Show Child Parameters
get/appointments
 
application/json