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

How do I use the V4 Inspections API to manage property inspections?

The V4 Inspections API covers the full property inspection lifecycle — from identifying properties and scheduling appointments to collecting tenant information and uploading inspection reports. All endpoints are at https://live-api.letmc.com/v4/inspections/.

Property inspection workflow

  1. Get branches — GET /v4/inspections/{shortName}/company/branches/{offset}/{count}
  2. Get properties by branch — GET /properties/{branchID}/{offset}/{count}
  3. Get property details — GET /properties/{propertyID}
  4. Get current tenancy — GET /properties/{propertyID}/tenancies/latest
  5. Get tenant information — GET /tenancies/{tenancyID}/tenants GDPR compliant — requires appropriate consent handling.

Scheduling inspection appointments

  • Get appointment types: GET /diary/appointmenttypes/{offset}/{count} — e.g. Routine Inspection, Check-in, Check-out, Mid-term Inspection
  • Get scheduled appointments: GET /diary/appointments/{offset}/{count} — filter by startDate, endDate, staffID, appointmentTypeID, propertyID
  • Get specific appointment: GET /diary/appointments/{appointmentID}

Staff and contacts

  • All staff: GET /contacts/staff/{offset}/{count}
  • Specific staff member: GET /contacts/staff/{staffID}
  • Landlord information: GET /contacts/landlords/{landlordID} (GDPR compliant — includes consent handling)

Historical context

  • Tenancy within a period: GET /properties/{propertyID}/tenancies/period (parameters: startDate, endDate)
  • Historical landlord: GET /properties/{propertyID}/landlord/period

Document upload

  • Upload to property: POST /documents/property/add
  • Upload to tenancy: POST /documents/tenancy/add

Supported formats: PDF, JPG, PNG, DOC, DOCX, XLS, XLSX. Maximum file size: 10MB.

Custom fields

  • Get definition: /company/object/{objectID}/customfield
  • Get value: /company/objects/{objectID}/{fieldID}/value
  • Set value: POST /company/objects/{objectID}/{fieldID}/customfield

GDPR note

Tenant and landlord endpoints handle personal data and include GDPR compliance features. Ensure your application handles consent appropriately.

Data relationships

Branch → Properties → Tenancies → Tenants | Property → Landlord | Appointments → Staff | Documents → Property or Tenancy

Test with Swagger: Select "V4.Inspections" from the tier dropdown. Pay particular attention to GDPR-related fields.