List Inbound Mail Items

Changed on
get/inbound_mail_items

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/inbound_mail_items
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

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

lockbox_recipient_idstring

Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.

lockbox_address_idstring

Filter Inbound Mail Items to ones sent to the provided Lockbox Address.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

Response

Inbound Mail Item List

next_cursorstring 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.

Example response

{
  "data": [
    {
      "account_id": "account_in71c4amph0vgo2qllky",
      "checks": [
        {
          "amount": 1750,
          "back_file_id": "file_makxrc67oh9l6sg7w9yc",
          "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
          "front_file_id": "file_makxrc67oh9l6sg7w9yc",
          "status": "deposited"
        },
        {
          "amount": 1750,
          "back_file_id": "file_makxrc67oh9l6sg7w9yc",
          "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
          "front_file_id": "file_makxrc67oh9l6sg7w9yc",
          "status": "deposited"
        }
      ],
      "created_at": "2020-01-31T23:59:59Z",
      "file_id": "file_makxrc67oh9l6sg7w9yc",
      "id": "inbound_mail_item_q6rrg7mmqpplx80zceev",
      "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6",
      "lockbox_recipient_id": "lockbox_3xt21ok13q19advds4t5",
      "recipient_name": "Ian Crease",
      "rejection_reason": null,
      "status": "processed",
      "type": "inbound_mail_item"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes