Skip to content
English - United Kingdom
  • There are no suggestions because the search field is empty.

How do I use the V4 Appointments API to manage property viewing bookings?

The V4 Appointments API handles the full lifecycle of property viewing appointments — from checking available slots and booking, through to updating, cancelling, and collecting post-viewing feedback. All endpoints are at https://live-api.letmc.com/v4/appointments/.

Property viewing booking workflow

This is the primary workflow for external websites and booking systems.

  1. Get branches — GET /v4/appointments/{shortName}/company/branches/{offset}/{count}
  2. Get available properties:
    • Lettings: GET /lettings/tenancies/advertised/{offset}/{count} (supports includeRenewals parameter)
    • Sales: GET /sales/instructions/advertised/{offset}/{count}
  3. Get appointment types — GET /diary/appointmenttypes/{offset}/{count} Returns configured types such as Property Viewing, Valuation, Check-in, etc.
  4. Check available time slots — GET /diary/appointmenttypes/allocations/{offset}/{count} Required: appointmentTypeID, preferredDate. Returns slots for the preferred date plus 7 days. Optional: lettings, propertyIdentifier, branchID.
  5. Match existing guest (optional) — GET /contacts/guest/match/{offset}/{count} Search for an existing contact to avoid duplicate records. Parameters: branchID, forename, emailaddress, surname.
  6. Book the appointment — POST /diary Required: AppointmentDiaryEntrySubmissionModel, propertyID (array), lettings (default true). Returns an appointment confirmation reference.

Staff appointment management workflow

For internal systems managing existing appointments:

  1. Get branches for filtering
  2. Get staff members — GET /contacts/staff/{offset}/{count} (filter by branchID)
  3. Get existing appointments — GET /diary/appointments/{branchID}/{offset}/{count} (filter by startDate, endDate, appointmentTypesToSearch)
  4. Get specific appointment — GET /diary/appointment/{appointmentID}
  5. Update appointment — PATCH /appointment/update using AppointmentDiaryEntryUpdateSubmissionModel — or — Cancel/uncancel — PATCH /diary/cancelationStatus/{cancelationStatus}
  6. Send communications — POST /messaging/{branchID}

Post-viewing feedback workflow

  1. Retrieve appointment details — GET /diary/appointment/{appointmentID}
  2. Submit feedback — POST /diary/feedback using AppointmentFeedbackSubmissionModel

Additional endpoints

  • Get specific appointment type: /diary/appointmenttypes/{appointmentTypeID}
  • Get specific staff member: /contacts/staff/{staffID}
  • Get recurring appointments: /diary/recurringappointment (requires branchID and appointmentTypesToSearch)

Important notes

  • All date/time parameters use ISO 8601 format
  • Appointment allocations are returned in the company's local timezone
  • Always check allocation availability immediately before booking to avoid conflicts
  • For property details (photos, descriptions), cross-reference with the V4 Advertising API

Test with Swagger: Select "V4.Appointments" from the tier dropdown.