List emails
Returns a page of the emails your company has sent, newest first, with the tenants, leases, owners, and vendors they went to.
Authorization
AuthorizationstringrequiredQuery parameters
pageintegerWhich page to return. The first page is 1.
pageSizeintegerHow many items to return per page. Between 1 and 100.
tenantIdsstring[]Only return emails sent to these tenants. Repeat the parameter once per id.
leaseIdsstring[]Only return emails sent to these leases.
ownerIdsstring[]Only return emails sent to these owners.
vendorIdsstring[]Only return emails sent to these vendors.
subjectLikestringOnly return emails whose subject contains this text.
bodyLikestringOnly return emails whose body contains this text.
Response
200 · One page of emails.
itemsEmailSummary[]The emails, newest page first.
currentPageintegerThe page number that was returned.
totalPagesintegerHow many pages exist at this page size.
pageSizeintegerHow many items a page holds.
totalCountintegerHow many items match in total, across every page.
tenantsTenant[]The tenants referenced by items[].targets.
leasesLease[]The leases referenced by items[].targets.
ownersOwner[]The owners referenced by items[].targets.
vendorsVendor[]The vendors referenced by items[].targets.
propertyManagersPropertyManager[]The property managers referenced by items[].propertyManagerId.
401 · The access token is missing, expired, or not valid.
Each entry in items names its recipients by id only. The tenants, leases, owners, vendors, and propertyManagers lists alongside items hold the full records for every id on the page, so you do not have to fetch them one at a time.