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

Create an appointment

post

Body

application/json

AppointmentInput

property_idstringrequired

Example:prop_8f2c1a

typestringrequired

Allowed values:individualgroupvirtual

Example:individual

startstring(date-time)required

Example:2026-09-03T16:00:00+02:00

duration_minutesinteger

Default:30

>= 10<= 240

slotsinteger

Only evaluated when type: group.

>= 1

Example:12

meeting_pointstring

<= 200 characters

Example:In front of the main entrance, 148 Elm Street

notestring

<= 500 characters

Example:Please bring photo ID; the unit is currently occupied.

Response

application/json

Created

Appointment

property_idstringrequired

Example:prop_8f2c1a

typestringrequired

Allowed values:individualgroupvirtual

Example:individual

startstring(date-time)required

Example:2026-09-03T16:00:00+02:00

duration_minutesinteger

Default:30

>= 10<= 240

slotsinteger

Only evaluated when type: group.

>= 1

Example:12

meeting_pointstring

<= 200 characters

Example:In front of the main entrance, 148 Elm Street

notestring

<= 500 characters

Example:Please bring photo ID; the unit is currently occupied.

idstring

Example:appt_9a44

statusstring

Allowed values:scheduledconfirmedcompletedcancelled

Example:confirmed

confirmations_countinteger

Example:8

waitlist_countinteger

Example:2

created_atstring(date-time)

Example:2026-08-20T11:02:10Z

post/appointments

Body

{ "property_id": "prop_8f2c1a", "type": "individual", "start": "2026-09-03T16:00:00+02:00", "duration_minutes": 30, "meeting_point": "In front of the main entrance, 148 Elm Street" }
 
application/json

Retrieve an appointment

get

Path Parameters

appointmentIdstringrequired

Example:appt_9a44

Response

application/json

Appointment

Appointment

property_idstringrequired

Example:prop_8f2c1a

typestringrequired

Allowed values:individualgroupvirtual

Example:individual

startstring(date-time)required

Example:2026-09-03T16:00:00+02:00

duration_minutesinteger

Default:30

>= 10<= 240

slotsinteger

Only evaluated when type: group.

>= 1

Example:12

meeting_pointstring

<= 200 characters

Example:In front of the main entrance, 148 Elm Street

notestring

<= 500 characters

Example:Please bring photo ID; the unit is currently occupied.

idstring

Example:appt_9a44

statusstring

Allowed values:scheduledconfirmedcompletedcancelled

Example:confirmed

confirmations_countinteger

Example:8

waitlist_countinteger

Example:2

created_atstring(date-time)

Example:2026-08-20T11:02:10Z

get/appointments/{appointmentId}
 
application/json