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

8446023e02fb

mailItems

Get a Mail Item

Get a mail item by its unique identifier.

A Mail Item is a unit of physical mail received at a Lockbox.

get/v1/mail_items/{id}

Path parameters

idstring required

The unique identifier for the mail item

Response

Successfully retrieved the mail item.

idstring required

The unique identifier for the mail item.

lockbox_idstring

The unique identifier for the lockbox that received the mail item.

status'processing' | 'needs_review' | 'processed' | 'rejected' required

The processing status of a Mail Item.

  • processing: The mail item is being scanned and parsed.
  • needs_review: Extraction completed but produced ambiguous results that require human review.
  • processed: The mail item has been successfully parsed and classified, and is ready for any downstream automations or workflows to run on it.
  • rejected: The mail item will not produce a Donation (e.g., return-to-sender, illegible, unrelated correspondence).
received_atstring date-time required

The date and time when the mail item was physically received at the lockbox.

created_atstring date-time required

The date and time when the mail item record was created.

updated_atstring date-time required

The date and time when the mail item record was last updated.

Example response

{
  "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"
}