---
title: "List Inbound Mail Items"
method: GET
path: "/inbound_mail_items"
---

# List Inbound Mail Items

`GET /inbound_mail_items`

## Query parameters

- `cursor` string — Return the page of entries after this one.
- `limit` integer — Limit the size of the list that is returned. The default (and maximum) is 100 objects.
- `lockbox_recipient_id` string — Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
- `lockbox_address_id` string — Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
- `created_at.after` string, date-time — Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
- `created_at.before` string, date-time — Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
- `created_at.on_or_after` string, date-time — Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
- `created_at.on_or_before` string, date-time — Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

## Response `200`

Inbound Mail Item List

- InboundMailItemList — A list of Inbound Mail Item objects.
  - `data` InboundMailItem[], required — The contents of the list.
    - `checks` InboundMailItemCheck[], required — The checks in the mail item.
      - `amount` integer, required — The amount of the check.
      - `back_file_id` string, nullable, required — The identifier for the File containing the back of the check.
      - `check_deposit_id` string, nullable, required — The identifier of the Check Deposit if this check was deposited.
      - `front_file_id` string, nullable, required — The identifier for the File containing the front of the check.
      - `status` 'pending' | 'deposited' | 'ignored', nullable, required — The status of the Inbound Mail Item Check.
    - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound Mail Item was created.
    - `file_id` string, required — The identifier for the File containing the scanned contents of the mail item.
    - `id` string, required — The Inbound Mail Item identifier.
    - `lockbox_address_id` string, required — The identifier for the Lockbox Address that received this mail item.
    - `lockbox_recipient_id` string, nullable, required — The identifier for the Lockbox Recipient that received this mail item. For mail items that could not be routed to a Lockbox Recipient, this will be null.
    - `recipient_name` string, nullable, required — The recipient name as written on the mail item.
    - `rejection_reason` 'no_matching_lockbox' | 'no_check' | 'lockbox_not_active' | 'lockbox_address_not_active' | 'lockbox_recipient_not_active', nullable, required — If the mail item has been rejected, why it was rejected.
    - `status` 'pending' | 'processed' | 'rejected', required — If the mail item has been processed.
    - `type` 'inbound_mail_item', required — A constant representing the object's type. For this resource it will always be `inbound_mail_item`.
  - `next_cursor` string, nullable, required — A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.

## Other responses

- `4XX` — Error
- `5XX` — Error

---

[API](https://skmtc.net/increase/apis/increase-api-2.md) · [All operations](https://skmtc.net/increase/apis/increase-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api-2/versions/e968bcd4dcf9/schema)