LetMC Api V2, Basic (Tier 2), an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://live-api.letmc.com
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
LetMC Api V2, Basic (Tier 2), an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /v2/tier2/{shortName}/area/areas | A collection of all the areas for a company AreaController |
GET | /v2/tier2/{shortName}/area/areas/{areaID} | Get a specific area given its unique Object ID (OID) AreaController |
GET | /v2/tier2/{shortName}/branch/branches | All branches defined for a company BranchController |
GET | /v2/tier2/{shortName}/branch/branches/{branchID} | Get a specific branch given its unique Object ID (OID) BranchController |
GET | /v2/tier2/{shortName}/company | Information about a specific company CompanyController |
GET | /v2/tier2/{shortName}/county/counties | A collection of all counties available for a company CountyController |
GET | /v2/tier2/{shortName}/county/counties/{countyID} | Get a specific county given its unique Object ID (OID) CountyController |
GET | /v2/tier2/{shortName}/county/counties/{countyID}/branches | A collection of branches that manage a specific county CountyController |
GET | /v2/tier2/{shortName}/diary/allocations | A collection of all diary allocations DiaryController |
GET | /v2/tier2/{shortName}/diary/allocations/{diaryAllocationID} | Get a specific diary allocation given its unique Object ID (OID) DiaryController |
GET | /v2/tier2/{shortName}/diary/appointments | A collection of all diary appointments DiaryController |
GET | /v2/tier2/{shortName}/diary/appointments/{diaryAppointmentID} | Get a specific diary appointment given its unique Object ID (OID) DiaryController |
GET | /v2/tier2/{shortName}/diary/appointmenttypes | A collection of all diary appointment types DiaryController |
GET | /v2/tier2/{shortName}/diary/appointmenttypes/{diaryAppointmentTypeID} | Get a specific diary appointment type given its unique Object ID (OID) DiaryController |
GET | /v2/tier2/{shortName}/lettings/advertised | Search all properties available for rent given a range of search criteria. LettingsController |
GET | /v2/tier2/{shortName}/lettings/advertisedbetweendates | Search all properties available for rent given a range of search criteria and dates. LettingsController |
GET | /v2/tier2/{shortName}/lettings/tenancies | A collection of all the company's tenancies LettingsController |
GET | /v2/tier2/{shortName}/lettings/tenancies/{tenancyID} | Get a specific tenancy given its unique Object ID (OID) LettingsController |
GET | /v2/tier2/{shortName}/lettings/tenancies/{tenancyID}/brochure | Downloads the brochure relating to the latest advertised rental of a property LettingsController |
GET | /v2/tier2/{shortName}/photo/photos | A collection of all photos in the company PhotoController |
GET | /v2/tier2/{shortName}/photo/photos/{photoID} | Get a specific photo given its unique Object ID (OID) PhotoController |
GET | /v2/tier2/{shortName}/photos/photo/{photoID}/download | Downloads the photo of a property given the property and photo ID. PhotoController |
GET | /v2/tier2/{shortName}/property/properties | A collection of all properties within a company PropertyController |
GET | /v2/tier2/{shortName}/property/properties/{propertyID} | Get a specific property given its unique Object ID (OID) PropertyController |
GET | /v2/tier2/{shortName}/property/properties/{propertyID}/facilities | A collection of facilities linked to a block, property or room PropertyController |
GET | /v2/tier2/{shortName}/property/properties/{propertyID}/photos | A collection showing all the photos linked to a specific block, property or room PropertyController |
GET | /v2/tier2/{shortName}/property/properties/{propertyID}/rooms | A collection of the rooms that belong to this property or block PropertyController |
GET | /v2/tier2/{shortName}/property/properties/{propertyID}/tenancies | A collection of all tenancies associated with this block, property or room PropertyController |
GET | /v2/tier2/{shortName}/property/structures/{propertyStructureID}/reports/eer | Downloads the energy efficiency report (EER) graph for a property PropertyController |
GET | /v2/tier2/{shortName}/property/structures/{propertyStructureID}/reports/eir | Downloads the environmental impact report (EIR) graph for a property PropertyController |
GET | /v2/tier2/{shortName}/sales/advertisedsales | Search all sales properties available given a range of search criteria SalesController |
GET | /v2/tier2/{shortName}/sales/reports/eer/{salesInstructionID} | Downloads the energy efficiency report (EER) graph for a sales instruction SalesController |
GET | /v2/tier2/{shortName}/sales/reports/eir/{salesInstructionID} | Downloads the energy efficiency report (EIR) graph for a sales instruction SalesController |
GET | /v2/tier2/{shortName}/sales/salesfeaturetypes | A collection of all sales feature types linked to a company SalesController |
GET | /v2/tier2/{shortName}/sales/salesfeaturetypes/{salesFeatureTypeID} | Get a specific sales feature type given its unique Object ID (OID) SalesController |
GET | /v2/tier2/{shortName}/sales/salesinstructions | A collection of all sales instructions linked to a company SalesController |
GET | /v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID} | Get a specific sales instruction given its unique Object ID (OID) SalesController |
GET | /v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/features | A collection of all features linked to a sales instruction SalesController |
GET | /v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/floorplans | A collection of floor plans linked to an instruction SalesController |
GET | /v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}/photos | A collection of photos linked to an instruction SalesController |
and 5 more operation(s) in this specification, all searchable.
specification origin: https://live-api.letmc.com/swagger/docs/v2-basic-tier
LetMC Api V2, Free (Tier 1), an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /v2/tier1/{shortName}/area/areas | A collection of all the areas for a company AreaController |
GET | /v2/tier1/{shortName}/area/areas/{areaID} | Get a specific area given its unique Object ID (OID) AreaController |
GET | /v2/tier1/{shortName}/branch/branches | All branches defined for a company BranchController |
GET | /v2/tier1/{shortName}/branch/branches/{branchID} | Get a specific branch given its unique Object ID (OID) BranchController |
GET | /v2/tier1/{shortName}/company | Information about a specific company CompanyController |
GET | /v2/tier1/{shortName}/county/counties | A collection of all counties available for a company CountyController |
GET | /v2/tier1/{shortName}/county/counties/{countyID} | Get a specific county given its unique Object ID (OID) CountyController |
GET | /v2/tier1/{shortName}/county/counties/{countyID}/branches | A collection of branches that manage a specific county CountyController |
GET | /v2/tier1/{shortName}/diary/allocations | A collection of all diary allocations DiaryController |
GET | /v2/tier1/{shortName}/diary/allocations/{diaryAllocationID} | Get a specific diary allocation given its unique Object ID (OID) DiaryController |
GET | /v2/tier1/{shortName}/diary/appointments | A collection of all diary appointments DiaryController |
GET | /v2/tier1/{shortName}/diary/appointments/{diaryAppointmentID} | Get a specific diary appointment given its unique Object ID (OID) DiaryController |
GET | /v2/tier1/{shortName}/diary/appointmenttypes | A collection of all diary appointment types DiaryController |
GET | /v2/tier1/{shortName}/diary/appointmenttypes/{diaryAppointmentTypeID} | Get a specific diary appointment type given its unique Object ID (OID) DiaryController |
GET | /v2/tier1/{shortName}/lettings/advertised | Search all properties available for rent given a range of search criteria. LettingsController |
GET | /v2/tier1/{shortName}/lettings/advertisedbetweendates | Search all properties available for rent given a range of search criteria and dates. LettingsController |
GET | /v2/tier1/{shortName}/lettings/tenancies | A collection of all the company's tenancies LettingsController |
GET | /v2/tier1/{shortName}/lettings/tenancies/{tenancyID} | Get a specific tenancy given its unique Object ID (OID) LettingsController |
GET | /v2/tier1/{shortName}/lettings/tenancies/{tenancyID}/brochure | Downloads the brochure relating to the latest advertised rental of a property LettingsController |
GET | /v2/tier1/{shortName}/photo/photos | A collection of all photos in the company PhotoController |
GET | /v2/tier1/{shortName}/photo/photos/{photoID} | Get a specific photo given its unique Object ID (OID) PhotoController |
GET | /v2/tier1/{shortName}/photos/photo/{photoID}/download | Downloads the photo of a property given the property and photo ID. PhotoController |
GET | /v2/tier1/{shortName}/property/properties | A collection of all properties within a company PropertyController |
GET | /v2/tier1/{shortName}/property/properties/{propertyID} | Get a specific property given its unique Object ID (OID) PropertyController |
GET | /v2/tier1/{shortName}/property/properties/{propertyID}/facilities | A collection of facilities linked to a block, property or room PropertyController |
GET | /v2/tier1/{shortName}/property/properties/{propertyID}/photos | A collection showing all the photos linked to a specific block, property or room PropertyController |
GET | /v2/tier1/{shortName}/property/properties/{propertyID}/rooms | A collection of the rooms that belong to this property or block PropertyController |
GET | /v2/tier1/{shortName}/property/properties/{propertyID}/tenancies | A collection of all tenancies associated with this block, property or room PropertyController |
GET | /v2/tier1/{shortName}/property/structures/{propertyStructureID}/reports/eer | Downloads the energy efficiency report (EER) graph for a property PropertyController |
GET | /v2/tier1/{shortName}/property/structures/{propertyStructureID}/reports/eir | Downloads the environmental impact report (EIR) graph for a property PropertyController |
GET | /v2/tier1/{shortName}/sales/advertisedsales | Search all sales properties available given a range of search criteria SalesController |
GET | /v2/tier1/{shortName}/sales/reports/eer/{salesInstructionID} | Downloads the energy efficiency report (EER) graph for a sales instruction SalesController |
GET | /v2/tier1/{shortName}/sales/reports/eir/{salesInstructionID} | Downloads the energy efficiency report (EIR) graph for a sales instruction SalesController |
GET | /v2/tier1/{shortName}/sales/salesfeaturetypes | A collection of all sales feature types linked to a company SalesController |
GET | /v2/tier1/{shortName}/sales/salesfeaturetypes/{salesFeatureTypeID} | Get a specific sales feature type given its unique Object ID (OID) SalesController |
GET | /v2/tier1/{shortName}/sales/salesinstructions | A collection of all sales instructions linked to a company SalesController |
GET | /v2/tier1/{shortName}/sales/salesinstructions/{salesInstructionID} | Get a specific sales instruction given its unique Object ID (OID) SalesController |
GET | /v2/tier1/{shortName}/sales/salesinstructions/{salesInstructionID}/features | A collection of all features linked to a sales instruction SalesController |
GET | /v2/tier1/{shortName}/sales/salesinstructions/{salesInstructionID}/floorplans | A collection of floor plans linked to an instruction SalesController |
GET | /v2/tier1/{shortName}/sales/salesinstructions/{salesInstructionID}/photos | A collection of photos linked to an instruction SalesController |
and 3 more operation(s) in this specification, all searchable.
specification origin: https://live-api.letmc.com/swagger/docs/v2-free-tier
agentOS Api V2, Customer Login Call Group, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /v2/customer/{shortName}/branch/branches | All branches defined for a company BranchController |
GET | /v2/customer/{shortName}/branch/branches/{branchID} | Get a specific branch given its unique Object ID (OID) BranchController |
GET | /v2/customer/{shortName}/landlord/accounting | Get the accounting details for the landlord. LandlordController |
GET | /v2/customer/{shortName}/landlord/document | Download a Document LandlordController |
GET | /v2/customer/{shortName}/landlord/inventory | Generate a Inventory PDF for a tenancy LandlordController |
GET | /v2/customer/{shortName}/landlord/invoice | Get an invoice pdf belonging to the landlord. LandlordController |
GET | /v2/customer/{shortName}/landlord/landlordcrmentries | Retrieve landlord's CRM ID LandlordController |
GET | /v2/customer/{shortName}/landlord/maintenance | Get Active maintenance jobs. LandlordController |
GET | /v2/customer/{shortName}/landlord/profitloss | Generate a Profit and Loss Report LandlordController |
GET | /v2/customer/{shortName}/landlord/rentarrears | Rent Arrears LandlordController |
GET | /v2/customer/{shortName}/landlord/sas | Generate a Self Assessment Tax Report LandlordController |
GET | /v2/customer/{shortName}/landlord/settings | Get contact details of all linked landlords. LandlordController |
GET | /v2/customer/{shortName}/landlord/summary | Get the summary details for the landlord. LandlordController |
GET | /v2/customer/{shortName}/landlord/tenancy | Get tenancy details. LandlordController |
POST | /v2/customer/{shortName}/landlord/tenancy/maintenance/preference | Post tenancy maintenance preferences:- LandlordController |
GET | /v2/customer/{shortName}/landlord/tenancyagreement | Generate a Tenancy Agreement Copy (PDF) LandlordController |
GET | /v2/customer/{shortName}/photo/download | Downloads the photo of a property given the photo ID. PhotoController |
GET | /v2/customer/{shortName}/property/{propertyID}/photos | A collection showing all the photos linked to a specific block, property or room PropertyController |
GET | /v2/customer/{shortName}/session | Gets information about the currently logged on customer. SessionController |
POST | /v2/customer/{shortName}/session | Login as a customer given their username and password. SessionController |
DELETE | /v2/customer/{shortName}/session | Logout a customer previously logged in via the Login endpoint. SessionController |
POST | /v2/customer/{shortName}/session/createlandlordlogin | Send a request to the in-tray to create a landlord login. SessionController |
PUT | /v2/customer/{shortName}/session/password | Change the password of a customer given their existing and new password. SessionController |
POST | /v2/customer/{shortName}/session/resetpassword | Reset the customer's password. An email will be sent out to reset. SessionController |
specification origin: https://live-api.letmc.com/swagger/docs/v2-customer
agentOS API V3, Diary Call Group, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /v3/diary/{shortName}/allocations | Get a list of all available allocations for a date + 7 days for a specified appointment type DiaryController |
GET | /v3/diary/{shortName}/appointment | Get an appointment by ID DiaryController |
POST | /v3/diary/{shortName}/appointment | Post an appointment into a valid diary allocation DiaryController |
PUT | /v3/diary/{shortName}/appointment | Update an existing appointment using its unique identifier DiaryController |
DELETE | /v3/diary/{shortName}/appointment | Delete an existing appointment using its unique identifier DiaryController |
POST | /v3/diary/{shortName}/appointment/feedback | Submit appointment feedback DiaryController |
PATCH | /v3/diary/{shortName}/appointment/{appointmentID}/cancel | Cancel an existing appointment using its unique identifier DiaryController |
GET | /v3/diary/{shortName}/appointmentsbetweendates | A collection of diary appointments linked to a company filtered between specific dates and by appointment type |
GET | /v3/diary/{shortName}/appointmenttypes | A collection of all diary appointment types DiaryController |
GET | /v3/diary/{shortName}/company/branches | All branches defined for a company CompanyController |
GET | /v3/diary/{shortName}/company/branches/{branchID} | Get a specific branch given its unique Object ID (OID) CompanyController |
GET | /v3/diary/{shortName}/recurringappointment | Retrieves all recurring appointments:- DiaryController |
GET | /v3/diary/{shortname}/{branchID}/guest/search | Match Guest Parameters with existing applicants DiaryController |
specification origin: https://live-api.letmc.com/swagger/docs/v3-diary
LetMC Api V3, reporting, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /v3/reporting/{shortName}/mortgagesbycreateddate | Return a collection of mortgages by created date from a specific date ReportingController |
GET | /v3/reporting/{shortName}/mortgagesbyupdateddate | Return a collection of all mortgages updated from a specific date ReportingController |
GET | /v3/reporting/{shortName}/repossesionsbycreateddate | Return a collection of repossessions by created date from a specific date ReportingController |
GET | /v3/reporting/{shortName}/repossesionsbyupdateddate | Return a collection of all reposessions updated from a specific date ReportingController |
specification origin: https://live-api.letmc.com/swagger/docs/v3-reporting
agentOS API V3, Maintenance Call Group, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
POST | /v3/maintenance/{shortName}/maintenance/{branchID}/createmaintenancejob | Create a maintenance job for a specific branch MaintenanceController |
specification origin: https://live-api.letmc.com/swagger/docs/v3-maintenance
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.