API Reference

Print Mail

Contacts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Contact

GET/print-mail/v1/contacts/{id}

Retrieve a contact.

Path ParametersExpand Collapse

id: string

ReturnsExpand Collapse

Contact = object { id, addressLine1, addressStatus, 20 more }

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.

One of the following:

"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.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

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.

Get Contact

HTTP

HTTP

TypeScript

Python

curl https://api.postgrid.com/print-mail/v1/contacts/$ID \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

200 example

{
  "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"
}

Returns Examples

200 example

{
  "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"
}