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

How do I use the V4 Notes API to create and retrieve notes?

The V4 Notes API allows you to create and retrieve notes attached to any system object — including people, properties, maintenance jobs, and sales instructions. All endpoints are at https://live-api.letmc.com/v4/notes/.

Complete note management workflow

  1. Get branches — GET /v4/notes/{shortName}/company/branches/{offset}/{count}
  2. Get available note types — GET /notes/types/{offset}/{count} Types include communication types (phone call, email, meeting), activity types (inspection, viewing, maintenance), and status types (progress update, completion report).
  3. Create a note for a person — POST /notes/{personID}/person Required: ObjectNoteSubmissionModel with note content, note type ID, and person ID.
  4. Retrieve notes for any object — GET /notes/{objectID}/object/{offset}/{count} Supports startDate and endDate query parameters for date range filtering.

Supported object types

Notes can be retrieved for any of the following object types:

Object Type Description
ApplicationStaff Staff member notes
ApplicationPerson Notes for any person (tenant, landlord, buyer, vendor)
SalesOffer Notes on sales offers
PropertyDeveloperSite Development site notes
MaintenanceJob Maintenance job notes
SalesInstruction Sales instruction notes
PropertyOwnable Property-specific notes
SalesPartExchange Part exchange notes

Date-based filtering

The notes retrieval endpoint supports comprehensive date filtering using ISO 8601 format (YYYY-MM-DD). Use this for historical analysis, compliance reporting, and staff productivity metrics.

Custom fields

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

Data relationships

Any object → Multiple notes | Note → Note type | Person → Notes across multiple related objects | Property → Notes on tenancies, maintenance jobs, and sales instructions

Test with Swagger: Select "V4.Notes" from the tier dropdown. Use Swagger to understand the ObjectNoteSubmissionModel structure and explore the different supported object types.