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

How does the legacy V3 System Events API work?

The V3 System Events API is a legacy tier for tenancy application submission, applicant creation, and property search from external systems. New integrations should use the V4 Applications API instead. All endpoints are at https://live-api.letmc.com/v3/systemevents/.

⚠️ Legacy API — existing integrations only. The V3 System Events API will not receive new features. For new integrations, use the V4 Applications API, which provides modern patterns, deduplication, and improved document handling.

Key characteristics

  • Complex submission models with extensive validation
  • Legacy query parameter pagination
  • Inline applicant creation with full preference setup in a single request
  • Document URLs must be publicly accessible (no direct upload)
  • No deduplication — each applicant submission creates a new record
  • Automatic audit trail creation for website registration tracking

Company and branch management

  • All branches: GET /v3/systemevents/{shortName}/company/branches Legacy pagination: ?offset=0&count=10. Maximum 1,000 per request.
  • Specific branch: GET /company/branches/{branchID}

Branch contact information

  • Get branch default email: GET /contacts/branch/{branchID} Returns SystemEventsBranchEmailModel — used by external systems to determine where to send automated notifications.

Property search

  • Search advertised properties: GET /properties Returns all active lettings tenancies with formatted descriptions and rent amounts. No filtering options — for large portfolios, this may return a significant volume of data.

Creating an applicant

POST /createapplicant

Uses SystemEventsCreateApplicantModel. Key behaviours:

  • Mobile phone validation is required
  • Email validation applies if an address is provided
  • Rent range defaults to £1–£10,000 per month if not specified
  • Bedroom requirement defaults to a minimum of 1
  • Tenant type defaults to "Employed" if an invalid value is provided
  • At least one alert method (email or SMS) must be enabled for alerts to be set up
  • Area preferences can be linked for targeted property alerts
  • An audit entry is created automatically for every submission

Submitting a tenancy application

POST /submittenancyapplication

Parameters: branchID, application data using ThirdPartySubmitTenancyApplicationWithDocumentsModel, optional documentType.

This endpoint creates inbox items for manual processing by branch staff — it does not trigger automated application processing.

Migrating to V4 Applications

The V4 Applications API offers: applicant deduplication and existing contact linking, direct document upload (no public URLs required), modern pagination, comprehensive application status tracking, and active feature development.

Test with Swagger: Select "V3.SystemEvents" from the tier dropdown. Use valid phone and email formats when testing — each submission creates a new applicant with an audit log entry.