---
title: "List Virtual Mailboxes"
method: GET
path: "/print-mail/v1/virtual_mailboxes"
tags: ["Virtual Mailboxes"]
---

# List Virtual Mailboxes

`GET /print-mail/v1/virtual_mailboxes`

Lists virtual mailboxes. You can use the `skip`, `limit`, and `search`
query parameters to refine the list.

## Query parameters

- `skip` integer
- `limit` integer
- `search` union
  - string
  - string — You can supply a structured search query instead of supplying unstructured text to any list endpoint help refine your search for a resource. For example, let's say you created a series of letters that all had `metadata: { campaignID: 'abc' }`. You could search for all those letters by passing in `{ "metadata.campaignID": "abc" }` into the `search` parameter. Note that this string must be valid JSON.

## Response `200`

The request has succeeded.

- object
  - `object` 'list', required
  - `totalCount` integer, required
  - `skip` integer, required
  - `limit` integer, required
  - `data` VirtualMailbox[], required
    - `id` string, required — A unique ID prefixed with virtual_mailbox_
    - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
    - `metadata` object — See the section on Metadata.
    - `live` boolean, required — `true` if this is a live mode resource else `false`.
    - `createdAt` string, date-time, required — The UTC time at which this resource was created.
    - `updatedAt` string, date-time, required — The UTC time at which this resource was last updated.
    - `object` 'virtual_mailbox', required — Always "virtual_mailbox".
    - `capabilities` VirtualMailboxCapabilities, required — All of the capabilities a virtual mailbox may have.
      - `envelopeScans` boolean, required — Indicates if the virtual mailbox can produce scans of envelopes.
      - `forwardMailTo` Contact
        - `id` string, required — A unique ID prefixed with contact_
        - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
        - `metadata` object — See the section on Metadata.
        - `live` boolean, required — `true` if this is a live mode resource else `false`.
        - `createdAt` string, date-time, required — The UTC time at which this resource was created.
        - `updatedAt` string, date-time, required — The UTC time at which this resource was last updated.
    - `status` 'active' | 'pending_assignment', required — The possible statuses of virtual mailboxes.
    - `countryCode` 'US', required — All of the supported countries for virtual mailboxes.

## Other responses

- `401` — Access is unauthorized.
- `404` — The server cannot find the requested resource.
- `422` — Client error
- `429` — Client error
- `500` — Server error

---

[API](https://skmtc.net/postgrid/apis/postgrid-address-verification-api.md) · [All operations](https://skmtc.net/postgrid/apis/postgrid-address-verification-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/postgrid/postgrid-address-verification-api/versions/537d2bbc624a/schema)