## Get Letter **get** `/print-mail/v1/letters/{id}` Retrieve a letter by ID. ### Path Parameters - `id: string` ### Returns - `Letter = object { id, addressPlacement, color, 29 more }` - `id: string` A unique ID prefixed with letter_ - `addressPlacement: AddressPlacement` Enum representing the placement of the address on the letter. - `"top_first_page"` - `"insert_blank_page"` - `color: boolean` Indicates if the letter is in color. - `createdAt: string` The UTC time at which this resource was created. - `doubleSided: boolean` Indicates if the letter is double-sided. - `envelope: string` The envelope (ID) for the letter or the default `standard` envelope. - `from: Contact` The contact information of the sender. - `id: string` A unique ID prefixed with contact_ - `addressLine1: string` The first line of the contact's address. - `addressStatus: "verified" or "corrected" or "failed"` One of `verified`, `corrected`, or `failed`. - `"verified"` - `"corrected"` - `"failed"` - `countryCode: string` The ISO 3611-1 country code of the contact's address. - `createdAt: string` The UTC time at which this resource was created. - `live: boolean` `true` if this is a live mode resource else `false`. - `object: "contact"` Always `contact`. - `"contact"` - `updatedAt: string` The UTC time at which this resource was last updated. - `addressErrors: optional string` A series of human-readable errors/warnings that were raised when running the provided address through our address verification. - `addressLine2: optional string` Second line of the contact's address, if applicable. - `city: optional string` The city of the contact's address. - `companyName: optional string` Company name of the contact. - `description: optional string` An optional string describing this resource. Will be visible in the API and the dashboard. - `email: optional string` Email of the contact. - `firstName: optional string` First name of the contact. - `forceVerifiedStatus: optional boolean` If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise. - `jobTitle: optional string` Job title of the contact. - `lastName: optional string` Last name of the contact. - `metadata: optional map[unknown]` See the section on Metadata. - `phoneNumber: optional string` Phone number of the contact. - `postalOrZip: optional string` The postal or ZIP code of the contact's address. - `provinceOrState: optional string` Province or state of the contact's address. - `skipVerification: optional boolean` If `true`, PostGrid will skip running this contact's address through our address verification system. - `live: boolean` `true` if this is a live mode resource else `false`. - `mailingClass: "first_class" or "standard_class" or "express" or 23 more` The mailing class of this order. This determines the speed and cost of delivery. See `OrderMailingClass` for more details. - `"first_class"` - `"standard_class"` - `"express"` - `"certified"` - `"certified_return_receipt"` - `"registered"` - `"usps_first_class"` - `"usps_standard_class"` - `"usps_eddm"` - `"usps_express_2_day"` - `"usps_express_3_day"` - `"usps_first_class_certified"` - `"usps_first_class_certified_return_receipt"` - `"usps_first_class_registered"` - `"usps_express_3_day_signature_confirmation"` - `"usps_express_3_day_certified"` - `"usps_express_3_day_certified_return_receipt"` - `"ca_post_lettermail"` - `"ca_post_personalized"` - `"ca_post_neighbourhood_mail"` - `"ups_express_overnight"` - `"ups_express_2_day"` - `"ups_express_3_day"` - `"royal_mail_first_class"` - `"royal_mail_second_class"` - `"au_post_second_class"` - `object: "letter"` Always `letter`. - `"letter"` - `sendDate: string` This order will transition from `ready` to `printing` on the day after this date. For example, if this is a date on Tuesday, the order will transition to `printing` on Wednesday at midnight eastern time. - `size: LetterSize` Enum representing the supported letter sizes. - `"us_letter"` - `"a4"` - `status: "ready" or "printing" or "processed_for_delivery" or 2 more` See `OrderStatus` for more details on the status of this order. - `"ready"` - `"printing"` - `"processed_for_delivery"` - `"completed"` - `"cancelled"` - `to: Contact` The recipient of this order. This will be provided even if you delete the underlying contact. - `updatedAt: string` The UTC time at which this resource was last updated. - `attachedPDF: optional AttachedPdf` Model representing an attached PDF. - `file: string` The file (multipart form upload) or URL pointing to a PDF for the attached PDF. - `placement: "before_template" or "after_template"` Enum representing the placement of the attached PDF. - `"before_template"` - `"after_template"` - `cancellation: optional object { reason, cancelledByUser, note }` The cancellation details of this order. Populated if the order has been cancelled. - `reason: "user_initiated" or "invalid_content" or "invalid_order_mailing_class"` The reason for the cancellation. - `"user_initiated"` - `"invalid_content"` - `"invalid_order_mailing_class"` - `cancelledByUser: optional string` The user ID who cancelled the order. - `note: optional string` An optional note provided by the user who cancelled the order. - `description: optional string` An optional string describing this resource. Will be visible in the API and the dashboard. - `html: optional string` The HTML content for the letter. You can supply _either_ this or `template` but not both. - `imbDate: optional string` The last date that the IMB status was updated. See `imbStatus` for more details. - `imbStatus: optional "entered_mail_stream" or "out_for_delivery" or "returned_to_sender"` The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders. - `"entered_mail_stream"` - `"out_for_delivery"` - `"returned_to_sender"` - `imbZIPCode: optional string` The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an `imbStatus` is present. - `mergeVariables: optional map[unknown]` These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template _exactly_ as they are case-sensitive. Note that these _do not_ apply to PDFs uploaded with the order. - `metadata: optional map[unknown]` See the section on Metadata. - `pdfWorkflowRun: optional string` The ID of the PDF workflow run that created the letter, if any. - `perforatedPage: optional 1` If specified, indicates which letter page is perforated. Currently, only the first page can be perforated. - `1` - `plasticCard: optional PlasticCard` Model representing a plastic card. - `size: "standard"` Enum representing the size of the plastic card. - `"standard"` - `doubleSided: optional object { backHTML, backTemplate, frontHTML, 2 more }` Model representing a double-sided plastic card. - `backHTML: optional string` The HTML content for the back side of the double-sided plastic card. - `backTemplate: optional string` The template ID for the back side of the double-sided plastic card. - `frontHTML: optional string` The HTML content for the front side of the double-sided plastic card. - `frontTemplate: optional string` The template ID for the front side of the double-sided plastic card. - `pdf: optional string` A URL pointing to a PDF file for the double-sided plastic card or the file itself. - `singleSided: optional object { html, pdf, template }` Model representing a single-sided plastic card. - `html: optional string` The HTML content for the single-sided plastic card. Can specify one of this, `template`, or `pdf`. - `pdf: optional string` A URL pointing to a PDF file for the single-sided plastic card or the PDF file itself. - `template: optional string` The template ID for the single-sided plastic card. - `returnEnvelope: optional string` The return envelope (ID) sent out with the letter, if any. - `template: optional string` The template ID used for the letter. You can supply _either_ this or `html` but not both. - `trackingNumber: optional string` The tracking number of this order. Populated after an express/certified order has been processed for delivery. - `uploadedPDF: optional string` If a PDF was uploaded for the letter, this will contain the signed link to the uploaded PDF. - `url: optional string` PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all `GET` endpoints which produce this order. This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the `GET` endpoint again. ### Example ```http curl https://api.postgrid.com/print-mail/v1/letters/$ID \ -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY" ``` #### Response ```json { "id": "letter_123456", "object": "letter", "status": "ready", "live": false, "to": { "id": "contact_pxd7wnnD1xY6H6etKNvjb4", "object": "contact", "live": false, "companyName": "PostGrid", "addressLine1": "90 CANAL ST STE 600", "city": "BOSTON", "provinceOrState": "MA", "postalOrZip": "90210-1234", "countryCode": "US", "skipVerification": false, "forceVerifiedStatus": false, "addressStatus": "verified", "createdAt": "2022-02-16T15:08:41.052Z", "updatedAt": "2022-02-16T15:08:41.052Z" }, "from": { "id": "contact_pxd7wnnD1xY6H6etKNvjb4", "object": "contact", "live": false, "companyName": "PostGrid", "addressLine1": "90 CANAL ST STE 600", "city": "BOSTON", "provinceOrState": "MA", "postalOrZip": "90210-1234", "countryCode": "US", "skipVerification": false, "forceVerifiedStatus": false, "addressStatus": "verified", "createdAt": "2022-02-16T15:08:41.052Z", "updatedAt": "2022-02-16T15:08:41.052Z" }, "size": "us_letter", "doubleSided": true, "color": false, "sendDate": "2020-11-12T23:23:47.974Z", "createdAt": "2020-11-12T23:23:47.974Z", "updatedAt": "2020-11-12T23:23:47.974Z", "mailingClass": "first_class", "envelope": "standard", "addressPlacement": "top_first_page", "html": "Content" } ```