Skip to content

PostScanMail/postman-collection

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Virtual Mailbox API (PostScan Mail) – Postman Collection

This repository provides the official Postman collection for the PostScan Mail Virtual Mailbox API and Mail Scanning API, allowing developers to receive, scan, manage, and automate physical mail digitally.

Get started in minutes and integrate real-world mail into your applications to build powerful workflows around document handling and mail automation.


🚀 What You Can Build

  • Automate incoming mail processing for your business
  • Sync scanned mail and documents to your CRM or database
  • Build a digital mailbox or virtual address platform
  • Trigger workflows when new mail arrives
  • Enable AI-powered document summarization and classification

🔐 Access Requirement

To use these APIs, you must have:

  • An active PostScan Mail account
  • Access to the Developer API

If you do not yet have access, requests will fail even if endpoints are reachable.

📧 Contact: api@postscanmail.com for onboarding


📦 What’s Included

  • Postman collection JSON export for current public endpoints
  • (Optional) Environment template with variables

🌐 Base URL

https://api.postscanmail.com/api/account-docs/v2/


🔑 Authentication

All requests require:

  • Header: x-api-key
  • Value: your API key

⚡ Quick Start

Get started in under 2 minutes:

  1. Download the collection JSON from this repository
  2. Open Postman → click Import → select the JSON file
  3. Set the following variables:
    • base_url = https://api.postscanmail.com/api/account-docs/v2/
    • api_key = YOUR_API_KEY
  4. Run requests from the available folders:
    • Mail Items
    • Automation Status
    • Automation Toggle

📬 Available Endpoints

  • Retrieve mail items and scanned documents
  • Manage automation settings
  • Enable or disable mail processing workflows

⚠️ Notes

  • Do not commit real API keys, customer IDs, or sensitive data
  • API access is restricted to authorized accounts only

💬 Support

📧 Email: api@postscanmail.com

About

Postman collection for the PostScan Mail Virtual Mailbox API. Easily test endpoints, manage mail items, and automate physical mail workflows.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors