Query Notes

Queries Notes on the Lockstep Platform using the specified filtering, sorting, nested fetch, and pagination rules requested.

More information on querying can be found on the Searchlight Query Language page on the Lockstep Developer website.

A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.

See Extensibility for more information.


To call this endpoint, you must have one of these roles:

  • Group Owner
  • Group Admin
  • Member
  • Read-Only

You can view your roles with the Status API.

Data Definition

See NoteModel for the complete data definition.

Click Try It! to start a request and see the response here!