v1 — Public API launch
The USGM Public API is now available.
Resources
- Mail items — list, fetch, update, archive/unarchive, and discard/undiscard mail.
- Folders — list, create, update, and delete folders.
- Addresses — list, create, update, delete, and manage default shipping and deposit addresses.
- Shipments — list and fetch shipment requests (read-only).
Platform
- API-key authentication (
usgmk_live_…/usgmk_test_…) with a full sandbox environment. - Cursor-based pagination on all list endpoints (
{ data, next_cursor }). - RFC 9457
application/problem+jsonerrors with arequest_idon every response. - Edge rate limiting with
X-RateLimit-*andRetry-Afterheaders.
Tooling
- Official SDKs for TypeScript, Python, PHP, and Go.
- An MCP server for AI coding agents.