API Referenceaccount

Get

Authentication

AuthorizationBearer

Your API key, sent as Authorization: Bearer usgmk_live_....

Response

idstring

Account id (UUID).

namestring
emailstring
created_atdatetime
Registration date.
phone_numberstring or null
statusstring or null

Account status as reported by USGM (e.g. APPROVED, SUSPENDED).

box_numberstring or null

The PMB (private mailbox) number. Null until a mailbox is assigned.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error