Query Emails

Queries Emails 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.

An Email represents a communication sent from one company to another. The creator of the email is identified by the CompanyId field, recipient(s) by the EmailTo field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.

Roles

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 EmailModel for the complete data definition.

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