OSG JourneyConnect API
The endpoints of the API are grouped based on the resources or
services they provide.
Communications
Commands
| Command |
Description |
| Send |
Send digital or print communication |
Mail Pieces
Commands
| Command |
Description |
| Events |
Retrieve the event history for one or more mail pieces |
| Get |
Retrieve detailed information for a single mail piece |
| Search |
Search for mail pieces |
| Statuses |
Retrieve the current tracking status |
Upload
Commands
Documents
Queries
| Query |
Description |
| Download |
Download a document using the unique identifier |
| GetById |
Retrieves the information for a document using the unique identifier |
| Search |
Searches for documents |
| View |
View a document |
Utilities
Commands
| Commands |
Description |
| Echo |
This operation can be used for testing authentication |
| Ping |
This operation is used for service health checks. |