# Specification

> Base URL, authentication and every endpoint, grouped by tag.

Web page: https://reference.earthclassmail.com/v1/rest-api/spec/

Endpoint reference for the Virtual Mail Public API. See [Overview](https://reference.earthclassmail.com/_llms_txt/v1/rest-api.md) for authentication, rate limits, and key concepts.

## Base URL

- `https://api.earthclassmail.com/v1`

## Authorization

Send your API key in the `x-api-key` header.

## Operations

### Scans

- [Get Bulk Piece Media](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/getbulkpiecemedia.md): `GET /media`
- [Get Piece Media](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/getpiecemedia.md): `GET /pieces/{piece_id}/media`
- [Get Piece Scans](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/getpiecescans.md): `GET /pieces/{piece_id}/scans`
- [Share Scan via Email](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/emailscan.md): `POST /scans/{scan_id}/email`

### CheckDeposits

- [Get Requested Check Deposits](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/listcheckdepositrequests.md): `GET /inboxes/{inbox_id}/check-deposit-requests`
- [Get Check Deposit Bank Accounts](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/listcheckdepositbankaccounts.md): `GET /inboxes/{inbox_id}/check-deposit-bank-accounts`
- [Get Requested Check Deposits for Piece](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/listpiececheckdepositrequests.md): `GET /pieces/{piece_id}/check-deposit-requests`
- [Request Check Deposit](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/requestcheckdeposit.md): `POST /pieces/{piece_id}/check-deposit-requests`
- [Cancel Check Deposit](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/cancelcheckdeposit.md): `DELETE /pieces/{piece_id}/check-deposit-requests/{check_deposit_request_id}`

### Inboxes

- [List Inboxes](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/listinboxes.md): `GET /users/{user_id}/inboxes`

### Pieces

- [List Inbox Pieces](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/listinboxpieces.md): `GET /inboxes/{inbox_id}/pieces`
- [Get Piece Details](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/getpiece.md): `GET /pieces/{piece_id}`
- [Archive Piece](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/archivepiece.md): `POST /pieces/{piece_id}/archive`
- [Unarchive Piece](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/unarchivepiece.md): `DELETE /pieces/{piece_id}/archive`

### Shred

- [Get Piece Shredding Details](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/getpieceshredding.md): `GET /pieces/{piece_id}/disposal`
- [Request Piece Shredding](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/requestpieceshredding.md): `POST /pieces/{piece_id}/disposal`
- [Cancel Pending Piece Shredding](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/cancelpieceshredding.md): `DELETE /pieces/{piece_id}/disposal`

### Shipping

- [Get Shipping Addresses](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/listshippingaddresses.md): `GET /inboxes/{inbox_id}/shipping-addresses`
- [Get Shipping Rates](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/getshippingrates.md): `POST /shipping-addresses/{shipping_address_id}/rate`
- [Get Shipments](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/listshipments.md): `GET /inboxes/{inbox_id}/shipments`
- [Create Shipment](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/createshipment.md): `POST /inboxes/{inbox_id}/shipments`

### Users

- [Get User](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/getuser.md): `GET /users/{user_id}`
- [Get Current User](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/getcurrentuser.md): `GET /user`
- [List User Accounts](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/listuseraccounts.md): `GET /users/{user_id}/accounts`
- [List User Recipients](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/listuserrecipients.md): `GET /users/{user_id}/recipients`

### Tags

- [Add Tags to Piece](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/setpiecetags.md): `PUT /pieces/{piece_id}/tags`
- [Remove Tag from Piece](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/removetagfrompiece.md): `DELETE /pieces/{piece_id}/tags/{tag_id}`
- [Update Tag](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/updateinboxtag.md): `PUT /inboxes/{inbox_id}/tags/{tag_id}`
- [Delete Tag](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/deleteinboxtag.md): `DELETE /inboxes/{inbox_id}/tags/{tag_id}`
- [List Inbox Tags](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/listinboxtags.md): `GET /inboxes/{inbox_id}/tags`
- [Create Tag](https://reference.earthclassmail.com/_llms_txt/v1/rest-api/spec/operations/createinboxtag.md): `POST /inboxes/{inbox_id}/tags`