Read payment, mailing status, scans and delivery estimates.

get/v1/letters/{id}

Request

  • Base URL: https://paperagent.dev
  • URL: https://paperagent.dev/v1/letters/{id}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://paperagent.dev/oauth/authorize, token URL https://paperagent.dev/oauth/token, scopes: letters:read)
    • API key in header X-Api-Key
    • HTTP bearer

Path parameters

idstring required

Response

Success

tracking_numberstring

USPS Certified Mail tracking number, present once the operator saves it.

tracking_urlstring

Direct USPS tracking link. Share it with the user when available.

letter_idstring required
livemodeboolean required

False for sandbox letters, which are never mailed.

tier'standard' | 'proof_of_mailing' | 'certified' | 'certified_err' | 'registered' required
status'pending_payment' | 'pending_moderation' | 'held_for_review' | 'queued' | 'printed' | 'postage_applied' | 'accepted_by_usps' | 'in_transit' | 'arrived_at_destination_facility' | 'expected_delivery' | 'delivered' | 'blocked' | 'cancelled' | 'payment_abandoned' | 'returned' required

Where the letter is. expected_delivery is the last state a standard or proof-of-mailing letter reaches; only certified tiers ever reach delivered.

descriptionstring required

One sentence for the user about where this letter is.

mail_datestring required

The calendar date (YYYY-MM-DD, New York time) this piece goes to USPS.

delivery_confirmationboolean required

False for every tier USPS does not scan at delivery. Never claim otherwise.

delivered_atstring nullable

Certified tiers only, and absent entirely for the tiers USPS does not scan.

disclosurestring nullable required

Say this to the user whenever an expected delivery date is shown.

created_atstring required
cancelled_atstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.