# Retrieve Recipients

Retrieve a list of recipients associated to a specific order.

Endpoint: GET /v1/order/{id}/recipients
Version: 1.0.0
Security: apikey

## Query parameters:

  - `Id` (integer, required)
    The Id of the order to retrieve the recipient list from.

  - `Query` (string)
    Search filter for recipient data. Filter by recipient name, address or organization.

  - `Skip` (integer)
    For pagination: Number of records to skip.

  - `Take` (integer)
    For pagination: Number of records to retrieve.

## Response 400 fields (application/json):

  - `payload` (object)

  - `payload.recipients` (array)

  - `payload.recipients.id` (integer)

  - `payload.recipients.address` (object,null)
    Recipient Mailing Address. Where the piece will be mailed to.

  - `payload.recipients.address.address1` (string,null)
    Recipient Address 1.

  - `payload.recipients.address.address2` (string,null)
    Recipient Address 2.

  - `payload.recipients.address.city` (string,null)
    Recipient City.

  - `payload.recipients.address.state` (string,null)
    Recipient State.

  - `payload.recipients.address.zipCode` (string,null)
    Recipient Zip Code.

  - `payload.recipients.address.zip4` (string,null)
    Recipient Zip+4.

  - `payload.recipients.address.zip2` (string,null)
    Recipient Delivery Point.

  - `payload.recipients.address.country` (string,null)
    Recipient Country (Optional, US only).

  - `payload.recipients.personal` (object,null)
    Recipient Personal Information

  - `payload.recipients.personal.firstName` (string,null)
    Recipient First Name.

  - `payload.recipients.personal.lastName` (string,null)
    Recipient Last Name.

  - `payload.recipients.personal.toOrganization` (string,null)
    Recipient Organization.

  - `payload.recipients.personal.salutation` (string)
    Recipient Salutation (used for Mail-Merge only).

  - `payload.recipients.metadata` (object,null)
    Recipient Metadata. This is used for Mail-Merge and Image-merge fields to personalize the mailing to the individual.

  - `payload.recipients.metadata.dpvConfirmationCode` (string)
    USPS Delivery Point Verification confirmation code.

  - `payload.recipients.metadata.custom1` (string)
    Mail-Merge Field: {{Custom 1}}

  - `payload.recipients.metadata.custom2` (string)
    Mail-Merge Field: {{Custom 2}}

  - `payload.recipients.metadata.custom3` (string)
    Mail-Merge Field: {{Custom 3}}

  - `payload.recipients.metadata.custom4` (string)
    Mail-Merge Field: {{Custom 4}}

  - `payload.recipients.metadata.custom5` (string)
    Mail-Merge Field: {{Custom 5}}

  - `payload.recipients.metadata.custom6` (string)
    Mail-Merge Field: {{Custom 6}}

  - `payload.recipients.metadata.image1` (string)
    Image-Merge Field: URL to Image 1 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image2` (string)
    Image-Merge Field: URL to Image 2 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image3` (string)
    Image-Merge Field: URL to Image 3 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image4` (string)
    Image-Merge Field: URL to Image 4 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image5` (string)
    Image-Merge Field: URL to Image 5 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image6` (string)
    Image-Merge Field: URL to Image 6 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.salutation` (string)
    Mail-Merge Field: {{Salutation}}

  - `payload.recipients.metadata.returnTitle` (string)
    Return Address Override: Return Title. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnFirstName` (string)
    Return Address Override: Return First Name. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnLastName` (string)
    Return Address Override: Return Last Name. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnOrganization` (string)
    Return Address Override: Return Organization Name. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnAddress1` (string)
    Return Address Override: Return Address 1. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnAddress2` (string)
    Return Address Override: Return Address 2. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnCity` (string)
    Return Address Override: Return City. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnZip` (string)
    Return Address Override: Return Zip. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnState` (string)
    Return Address Override: Return State. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.email` (string)
    Mail-Merge Field: {{Email}}

  - `payload.recipients.metadata.qrUrl` (string)
    QR URL Override: Providing a QR URL for a recipient overrides the QR URL in the design template. A QR must exist in the design template to provide this field.

  - `payload.recipients.metadata.text` (string)
    Handwritten Text: Returns the handwritten text on the design template (if product is handwritten).

  - `payload.recipients.metadata.text2` (string)
    Bifold Secondary Handwritten Text: Returns the handwritten text on the bottom panel of the bifold card in design template (if product is Bifold).

  - `payload.recipients.metadata.radiusPinStreet` (string)
    Radius Mail: Returns the Radius Pin Street.

  - `payload.recipients.metadata.radiusPinAddress` (string)
    Radius Mail: Returns the Radius Pin Address.

  - `payload.recipients.metadata.fullAddress` (string)
    Full Address Field: If the full address is provided as single string, the address will be decomposed post-validation into the send address fields. Provide either the FullAddress, or the decomposed fields above (e.g. Address 1, City, State, etc.), both not both.

  - `payload.orderId` (integer)

  - `payload.status` (string)

  - `errors` (array)

  - `warnings` (array)

  - `hasErrors` (boolean)

  - `hasWarnings` (boolean)

## Response 401 fields (application/json):

  - `payload` (object)

  - `payload.recipients` (array)

  - `payload.recipients.id` (integer)

  - `payload.recipients.address` (object,null)
    Recipient Mailing Address. Where the piece will be mailed to.

  - `payload.recipients.address.address1` (string,null)
    Recipient Address 1.

  - `payload.recipients.address.address2` (string,null)
    Recipient Address 2.

  - `payload.recipients.address.city` (string,null)
    Recipient City.

  - `payload.recipients.address.state` (string,null)
    Recipient State.

  - `payload.recipients.address.zipCode` (string,null)
    Recipient Zip Code.

  - `payload.recipients.address.zip4` (string,null)
    Recipient Zip+4.

  - `payload.recipients.address.zip2` (string,null)
    Recipient Delivery Point.

  - `payload.recipients.address.country` (string,null)
    Recipient Country (Optional, US only).

  - `payload.recipients.personal` (object,null)
    Recipient Personal Information

  - `payload.recipients.personal.firstName` (string,null)
    Recipient First Name.

  - `payload.recipients.personal.lastName` (string,null)
    Recipient Last Name.

  - `payload.recipients.personal.toOrganization` (string,null)
    Recipient Organization.

  - `payload.recipients.personal.salutation` (string)
    Recipient Salutation (used for Mail-Merge only).

  - `payload.recipients.metadata` (object,null)
    Recipient Metadata. This is used for Mail-Merge and Image-merge fields to personalize the mailing to the individual.

  - `payload.recipients.metadata.dpvConfirmationCode` (string)
    USPS Delivery Point Verification confirmation code.

  - `payload.recipients.metadata.custom1` (string)
    Mail-Merge Field: {{Custom 1}}

  - `payload.recipients.metadata.custom2` (string)
    Mail-Merge Field: {{Custom 2}}

  - `payload.recipients.metadata.custom3` (string)
    Mail-Merge Field: {{Custom 3}}

  - `payload.recipients.metadata.custom4` (string)
    Mail-Merge Field: {{Custom 4}}

  - `payload.recipients.metadata.custom5` (string)
    Mail-Merge Field: {{Custom 5}}

  - `payload.recipients.metadata.custom6` (string)
    Mail-Merge Field: {{Custom 6}}

  - `payload.recipients.metadata.image1` (string)
    Image-Merge Field: URL to Image 1 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image2` (string)
    Image-Merge Field: URL to Image 2 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image3` (string)
    Image-Merge Field: URL to Image 3 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image4` (string)
    Image-Merge Field: URL to Image 4 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image5` (string)
    Image-Merge Field: URL to Image 5 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image6` (string)
    Image-Merge Field: URL to Image 6 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.salutation` (string)
    Mail-Merge Field: {{Salutation}}

  - `payload.recipients.metadata.returnTitle` (string)
    Return Address Override: Return Title. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnFirstName` (string)
    Return Address Override: Return First Name. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnLastName` (string)
    Return Address Override: Return Last Name. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnOrganization` (string)
    Return Address Override: Return Organization Name. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnAddress1` (string)
    Return Address Override: Return Address 1. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnAddress2` (string)
    Return Address Override: Return Address 2. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnCity` (string)
    Return Address Override: Return City. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnZip` (string)
    Return Address Override: Return Zip. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnState` (string)
    Return Address Override: Return State. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.email` (string)
    Mail-Merge Field: {{Email}}

  - `payload.recipients.metadata.qrUrl` (string)
    QR URL Override: Providing a QR URL for a recipient overrides the QR URL in the design template. A QR must exist in the design template to provide this field.

  - `payload.recipients.metadata.text` (string)
    Handwritten Text: Returns the handwritten text on the design template (if product is handwritten).

  - `payload.recipients.metadata.text2` (string)
    Bifold Secondary Handwritten Text: Returns the handwritten text on the bottom panel of the bifold card in design template (if product is Bifold).

  - `payload.recipients.metadata.radiusPinStreet` (string)
    Radius Mail: Returns the Radius Pin Street.

  - `payload.recipients.metadata.radiusPinAddress` (string)
    Radius Mail: Returns the Radius Pin Address.

  - `payload.recipients.metadata.fullAddress` (string)
    Full Address Field: If the full address is provided as single string, the address will be decomposed post-validation into the send address fields. Provide either the FullAddress, or the decomposed fields above (e.g. Address 1, City, State, etc.), both not both.

  - `payload.orderId` (integer)

  - `payload.status` (string)

  - `errors` (array)

  - `warnings` (array)

  - `hasErrors` (boolean)

  - `hasWarnings` (boolean)

## Response 403 fields (application/json):

  - `payload` (object)

  - `payload.recipients` (array)

  - `payload.recipients.id` (integer)

  - `payload.recipients.address` (object,null)
    Recipient Mailing Address. Where the piece will be mailed to.

  - `payload.recipients.address.address1` (string,null)
    Recipient Address 1.

  - `payload.recipients.address.address2` (string,null)
    Recipient Address 2.

  - `payload.recipients.address.city` (string,null)
    Recipient City.

  - `payload.recipients.address.state` (string,null)
    Recipient State.

  - `payload.recipients.address.zipCode` (string,null)
    Recipient Zip Code.

  - `payload.recipients.address.zip4` (string,null)
    Recipient Zip+4.

  - `payload.recipients.address.zip2` (string,null)
    Recipient Delivery Point.

  - `payload.recipients.address.country` (string,null)
    Recipient Country (Optional, US only).

  - `payload.recipients.personal` (object,null)
    Recipient Personal Information

  - `payload.recipients.personal.firstName` (string,null)
    Recipient First Name.

  - `payload.recipients.personal.lastName` (string,null)
    Recipient Last Name.

  - `payload.recipients.personal.toOrganization` (string,null)
    Recipient Organization.

  - `payload.recipients.personal.salutation` (string)
    Recipient Salutation (used for Mail-Merge only).

  - `payload.recipients.metadata` (object,null)
    Recipient Metadata. This is used for Mail-Merge and Image-merge fields to personalize the mailing to the individual.

  - `payload.recipients.metadata.dpvConfirmationCode` (string)
    USPS Delivery Point Verification confirmation code.

  - `payload.recipients.metadata.custom1` (string)
    Mail-Merge Field: {{Custom 1}}

  - `payload.recipients.metadata.custom2` (string)
    Mail-Merge Field: {{Custom 2}}

  - `payload.recipients.metadata.custom3` (string)
    Mail-Merge Field: {{Custom 3}}

  - `payload.recipients.metadata.custom4` (string)
    Mail-Merge Field: {{Custom 4}}

  - `payload.recipients.metadata.custom5` (string)
    Mail-Merge Field: {{Custom 5}}

  - `payload.recipients.metadata.custom6` (string)
    Mail-Merge Field: {{Custom 6}}

  - `payload.recipients.metadata.image1` (string)
    Image-Merge Field: URL to Image 1 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image2` (string)
    Image-Merge Field: URL to Image 2 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image3` (string)
    Image-Merge Field: URL to Image 3 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image4` (string)
    Image-Merge Field: URL to Image 4 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image5` (string)
    Image-Merge Field: URL to Image 5 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.image6` (string)
    Image-Merge Field: URL to Image 6 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG.

  - `payload.recipients.metadata.salutation` (string)
    Mail-Merge Field: {{Salutation}}

  - `payload.recipients.metadata.returnTitle` (string)
    Return Address Override: Return Title. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnFirstName` (string)
    Return Address Override: Return First Name. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnLastName` (string)
    Return Address Override: Return Last Name. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnOrganization` (string)
    Return Address Override: Return Organization Name. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnAddress1` (string)
    Return Address Override: Return Address 1. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnAddress2` (string)
    Return Address Override: Return Address 2. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnCity` (string)
    Return Address Override: Return City. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnZip` (string)
    Return Address Override: Return Zip. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.returnState` (string)
    Return Address Override: Return State. This overrides the return address fields set in the design template.

  - `payload.recipients.metadata.email` (string)
    Mail-Merge Field: {{Email}}

  - `payload.recipients.metadata.qrUrl` (string)
    QR URL Override: Providing a QR URL for a recipient overrides the QR URL in the design template. A QR must exist in the design template to provide this field.

  - `payload.recipients.metadata.text` (string)
    Handwritten Text: Returns the handwritten text on the design template (if product is handwritten).

  - `payload.recipients.metadata.text2` (string)
    Bifold Secondary Handwritten Text: Returns the handwritten text on the bottom panel of the bifold card in design template (if product is Bifold).

  - `payload.recipients.metadata.radiusPinStreet` (string)
    Radius Mail: Returns the Radius Pin Street.

  - `payload.recipients.metadata.radiusPinAddress` (string)
    Radius Mail: Returns the Radius Pin Address.

  - `payload.recipients.metadata.fullAddress` (string)
    Full Address Field: If the full address is provided as single string, the address will be decomposed post-validation into the send address fields. Provide either the FullAddress, or the decomposed fields above (e.g. Address 1, City, State, etc.), both not both.

  - `payload.orderId` (integer)

  - `payload.status` (string)

  - `errors` (array)

  - `warnings` (array)

  - `hasErrors` (boolean)

  - `hasWarnings` (boolean)