Skip to main content
GET
List entity mail
Returns a list of all mail items received at the entity’s lockbox. Each item includes a file_id for the scanned PDF and an amount representing the total value of any checks found in that piece of mail. If the mail contained checks, they are listed in the checks array.

Path parameters

entity_id
string
required
The ID of the entity. You can find entity IDs using the List entities endpoint.

Query parameters

limit
integer
default:"10"
Maximum number of mail items to return per page. Default is 10, maximum is 100.
cursor
string
Pagination cursor for retrieving the next page of results. Returned as cursor in the response. See pagination for details.
received.on_or_after
string
Filter to mail received at or after this timestamp. ISO 8601 format.
received.on_or_before
string
Filter to mail received at or before this timestamp. ISO 8601 format.

Response

has_next
boolean
Whether more mail items exist beyond this page. Use the cursor field to retrieve the next page.
cursor
string | null
Cursor to retrieve the next page of results. Null if this is the last page. Pass this value as the cursor query parameter in a subsequent request. See pagination for details.
data
object[]
The list of mail objects.