Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-2082100373.0 KB

8446023e02fb

mailItems

List Mail Items

List mail items for your account.

A Mail Item is a unit of physical mail received at a Lockbox. It has its own lifecycle and is the operational unit reviewers act on. Each Mail Item may produce zero or more Donations and zero or one Deposit.

get/v1/mail_items

Query parameters

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

page_tokenstring

The cursor to use for pagination. If not set, the first page of results will be returned.

lockbox_idstring

The unique identifier for the lockbox to filter mail items by.

status.inMailItemStatus[]

Filter Mail Items to only those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?status.in=needs_review,processing.

[
  "processed"
]
created_at.afterstring date-time

Return mail items created after the given date and time.

created_at.beforestring date-time

Return mail items created before the given date and time.

Response

The response for MailItems.list

next_page_tokenstring

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Example response

{
  "results": [
    {
      "id": "mail_01j8rs605a4gctmbm58d87mvsj",
      "lockbox_id": "lockbox_01j8rs605a4gctmbm58d87mvsj",
      "status": "processed",
      "received_at": "2020-01-31T23:59:59Z",
      "scans": [
        {
          "file_id": "file_01j8rs605a4gctmbm58d87mvsj",
          "created_at": "2020-01-31T23:59:59Z"
        }
      ],
      "created_at": "2020-01-31T23:59:59Z",
      "updated_at": "2020-01-31T23:59:59Z"
    }
  ]
}