Skip to main content
GET
/
v0
/
entities
/
{entity_id}
/
mail
List entity mail
curl --request GET \
  --url https://api.getlemma.com/v0/entities/{entity_id}/mail \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "inbound_mail_item_Kv7nWp3hTx9cBd5m",
      "entity_id": "entity_k7mXp2vR9nTfBw4s",
      "file_id": "file_Xt7nRv3hBw9pKm4s",
      "amount": 372500,
      "checks": [
        {
          "id": "check_deposit_Tm6bXn9hRw3pFk7c",
          "amount": 100000,
          "transaction_id": "transaction_Ab5cDx3nKv8bTh2d",
          "status": "submitted",
          "hold": {
            "status": "held",
            "automatically_releases_at": "2026-03-19T14:00:00Z",
            "released_at": null
          },
          "micr": {
            "routing_number": "021000021",
            "account_number": "9876543210",
            "auxiliary_on_us": null,
            "serial_number": "00012345"
          }
        },
        {
          "id": "check_deposit_Jd4xVs8mBn2wYh5t",
          "amount": 2000,
          "transaction_id": null,
          "status": "rejected",
          "hold": null,
          "micr": null
        }
      ],
      "received_at": "2026-03-14T14:00:00Z"
    },
    {
      "id": "inbound_mail_item_Rs4bFj8wNm2yHt6x",
      "entity_id": "entity_k7mXp2vR9nTfBw4s",
      "file_id": "file_Hd5cWm8nTx2vFk7b",
      "amount": 0,
      "checks": [],
      "received_at": "2026-03-13T10:45:00Z"
    }
  ]
}
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

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

data
object[]
The list of mail objects.
{
  "data": [
    {
      "id": "inbound_mail_item_Kv7nWp3hTx9cBd5m",
      "entity_id": "entity_k7mXp2vR9nTfBw4s",
      "file_id": "file_Xt7nRv3hBw9pKm4s",
      "amount": 372500,
      "checks": [
        {
          "id": "check_deposit_Tm6bXn9hRw3pFk7c",
          "amount": 100000,
          "transaction_id": "transaction_Ab5cDx3nKv8bTh2d",
          "status": "submitted",
          "hold": {
            "status": "held",
            "automatically_releases_at": "2026-03-19T14:00:00Z",
            "released_at": null
          },
          "micr": {
            "routing_number": "021000021",
            "account_number": "9876543210",
            "auxiliary_on_us": null,
            "serial_number": "00012345"
          }
        },
        {
          "id": "check_deposit_Jd4xVs8mBn2wYh5t",
          "amount": 2000,
          "transaction_id": null,
          "status": "rejected",
          "hold": null,
          "micr": null
        }
      ],
      "received_at": "2026-03-14T14:00:00Z"
    },
    {
      "id": "inbound_mail_item_Rs4bFj8wNm2yHt6x",
      "entity_id": "entity_k7mXp2vR9nTfBw4s",
      "file_id": "file_Hd5cWm8nTx2vFk7b",
      "amount": 0,
      "checks": [],
      "received_at": "2026-03-13T10:45:00Z"
    }
  ]
}