For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Status Dashboard

Guides API Reference SDKs MCP Changelog

API Reference
Problem types

Liveness
Readiness
List
Get
Update
Archive
Unarchive
Discard
Undiscard
List
Create
Get
Delete
File
Summary
Cancel
List
Get
List
Create
Get
Delete
Update
List
Create
Getdefault
Get
Delete
Update
Setdefault
Bank Accounts List
Bank Accounts Create
Bank Accounts Get
Bank Accounts Delete
Bank Accounts Update
Get
Mailingaddress
Seed
Seedmail
Completescan
Overview
bad_request
unauthorized
forbidden
not_found
method_not_allowed
conflict
unsupported_media_type
validation_error
rate_limited
internal_error
bad_gateway
service_unavailable
gateway_timeout

Status Dashboard

API Reference health

Readiness

GET

/v1/health/ready

GET

/v1/health/ready

$ curl https://api.usglobalmail.com/v1/health/ready \
>      -H "Content-Type: application/json"

200Retrieved

1 {}

Response

Process is ready to serve traffic.

Was this page helpful?