---
title: "List all mail items"
method: GET
path: "/v1/mail-items"
tags: ["Mail Items"]
---

# List all mail items

`GET /v1/mail-items`

Returns a list of mail items associated with your account.

## Query parameters

- `id` string
- `locationId` string
- `createdAt_gt` string
- `createdAt_gte` string
- `createdAt_lt` string
- `createdAt_lte` string
- `scan.status` string
- `scan.createdAt` string
- `scan.createdAt_gt` string
- `scan.createdAt_gte` string
- `scan.createdAt_lt` string
- `scan.createdAt_lte` string
- `first` string
- `after` string
- `last` string
- `before` string

## Headers

- `x-api-key` string, required

## Response `200`

Success

- MailItemsConnection
  - `edges` object[], required
    - `cursor` string, required
    - `node` MailItem, required
      - `id` string, required
      - `from` string, required
      - `archivedAt` string
      - `readAt` string
      - `barcodeId` string
      - `businessRecipient` string — @deprecated Use the `recipients` field to get the recipient information
      - `individualRecipient` string — @deprecated Use the `recipients` field to get the recipient information
      - `recipients` object, required
        - `line1` object, required
          - `text` string, required
        - `line2` object
          - `text` string, required
        - `individual` object
          - `id` string, required
          - `firstName` string, required
          - `lastName` string, required
        - `business` object
          - `id` string, required
          - `name` string, required
      - `clearAt` string, required
      - `imageUrl` string, required
      - `ocrResultUrls` string[]
      - `location` Location, required
        - `id` string, required
        - `status` 'active' | 'inactive', required
        - `address` object, required
          - `line1` string, required
          - `line2` string, required
          - `city` string, required
          - `state` string, required
          - `postalCode` string, required
        - `type` 'cmra' | 'registeredAgent', required
        - `onboarding` object, required
          - `status` 'authorize' | 'sign' | 'verify' | 'complete', required
        - `metadata` object, required
      - `depositDetails` object, required
        - `trackingNumber` string, required
        - `status` 'completed' | 'processing', required
      - `forwardDetails` object, required
        - `trackingNumber` string, required
        - `cost` number, required
        - `status` 'completed' | 'processing', required
      - `scanDetails` object, required
        - `imageUrl` string, required
        - `status` 'completed' | 'processing', required
        - `ocrResultUrls` string[]
        - `summary` string
        - `scanNoticeType` 'arrivedDamaged' | 'damagedDuringHandling' | 'lowQualityOriginal' | 'cdOrDisc' | 'flashDriveOrUsbDevice' | 'exceedsPageLimit' | 'emptyEnvelopeOrPackage' | 'tooSmallOrFragilePaper' | 'pagesTooLarge' | 'bookletOrBoundItem' | 'cantUseScannerOther' | 'ballot' | 'currency' | 'creditCard' | 'inappropriateContents' | 'alcohol' | 'perishables' | 'multipleItems' | 'returnedMail'
      - `shredDetails` object, required
        - `status` 'completed' | 'processing', required
      - `checks` Check[], required
        - `id` string, required
        - `amount` number, required
        - `currency` string, required
        - `checkNumber` string
        - `createdAt` string, required
        - `mailItemId` string, required
        - `payer` string
        - `payee` string
        - `memo` string
        - `issueDate` string
        - `voidDate` string — The date the check will become void, based on information printed on the check (e.g. "void after 90 days").
        - `accountNumber` string
        - `routingNumber` string
        - `returnReason` string — The reason the check was returned (e.g. "STOP PAYMENT", "CLOSED ACCOUNT", "DUPLICATE PRESENTMENT", "NOT SUFFICIENT FUNDS", "REFER TO MAKER").
        - `status` 'notRequested' | 'processing' | 'completed' | 'failed', required
        - `destinationAccount` CheckDestinationAccount
          - `id` string, required — The unique ID of the account the check was deposited into.
          - `name` string, required — The display name of the account the check was deposited into.
          - `type` 'electronic' | 'mailIn', required
          - `last4` string, required — The last 4 digits of the destination account number.
        - `statusTransitions` object, required
          - `processing` string
          - `completed` string
          - `failed` string
        - `failureDetails` object
          - `description` string, required
          - `code` string, required
        - `images` CheckImage[], required — Images associated with this check (e.g. full-page scan, cropped check)
          - `type` 'front_full' | 'front_cropped', required — The type of image
          - `url` string, required — A signed URL to the image
      - `tags` AssignedTag[], required
        - `id` string, required
        - `name` string, required
        - `createdAt` string, required
        - `updatedAt` string, required
        - `assignedAt` string, required
      - `teams` Team[], required
        - `id` string, required
        - `name` string, required
        - `createdAt` string, required
        - `updatedAt` string, required
      - `dataExtractionResults` DataExtractionResult[], required
        - `id` string, required — The ID of this data extraction result.
        - `extractor` Extractor, required
          - `id` string, required — The ID of the extractor.
          - `name` string, required — The name of the extractor.
        - `status` 'pending' | 'succeeded' | 'failed' | 'deleted', required
        - `succeededAt` string — When the extraction succeeded, or null if not yet succeeded.
        - `failedAt` string — When the extraction failed, or null if not failed.
        - `deletedAt` string — When the result was deleted, or null if not deleted.
        - `extractedData` unknown[], required — The extracted data. An empty array indicates no data was extracted for this document.
          - unknown
      - `isReturnedToSender` boolean — True if the mail item appears to be returned to sender.
  - `pageInfo` object, required
    - `endCursor` string
    - `hasNextPage` boolean, required
    - `hasPreviousPage` boolean, required
    - `startCursor` string
  - `totalCount` number, required

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/usestable/apis/stable-api.md) · [All operations](https://skmtc.net/usestable/apis/stable-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usestable/stable-api/revisions/c2ca8cbbc51e/schema)