How do I use the V4 Concierge API for utility switching and sales completion services?
The V4 Concierge API gives authorised third-party service providers access to tenant, landlord, and property data for utility switching and sales completion workflows. GDPR consent is enforced automatically. All endpoints are at https://live-api.letmc.com/v4/concierge/.
Who this API is for
The V4 Concierge API is designed for authorised third-party providers including utility switching companies, property concierge services, and sales completion specialists. Standard API keys do not provide access — a concierge-specific API key is required. Contact your client to request this.
GDPR compliance
This API enforces GDPR consent checking automatically. Tenant and landlord contact data is only returned when the individual has provided explicit consent for "Concierge Services" data processing. This cannot be bypassed. Each contact record includes consent status — integrators must respect any data processing restrictions indicated.
Utility switching workflow
- Get branches —
GET /v4/concierge/{shortName}/company/branches/{offset}/{count} - Get concierge-managed tenancies —
GET /tenancies/conciergemanaged/{offset}/{count}(filter bybranchID) - Get tenant contacts —
GET /contacts/tenants/{offset}/{count}(GDPR protected; filter bytenancyID) - Get property details —
GET /properties/{propertyID}Returns address, gas and electricity meter numbers, EPC energy ratings, and council tax band — specifically designed for utility switching. - Get landlord details —
GET /contacts/landlord/{landlordID}(GDPR protected)
Sales completion workflow
- Get branches
- Get concierge-managed sales instructions —
GET /salesinstructions/conciergemanaged/{offset}/{count}(filter bybranchID,startDate,endDate) - Get vendor information —
GET /contacts/vendors/{offset}/{count}(filter bysalesInstructionID) - Get purchaser information —
GET /contacts/purchasers(filter bysalesInstructionID) - Get property information —
GET /properties/{propertyID}
Additional endpoints
- Specific branch:
/company/branches/{branchID} - Specific geographical area:
/company/areas/{areaID} - Specific tenant:
/contacts/tenants/{tenantID}(GDPR protected) - Specific vendor:
/contacts/vendors/{vendorID}
Custom field management
- Get definition:
/company/object/{objectID}/customfield - Get value:
/company/objects/{objectID}/{fieldID}/value - Set value:
POST /company/objects/{objectID}/{fieldID}/customfield
Test with Swagger: Select "V4.Concierge" from the tier dropdown. Remember that personal data will only be returned if GDPR consent exists for concierge services.