List Recipients

Get Recipients of Job

In this section, you will learn how you can get a list of all the recipients associated with a job

URL Config

Method: GET
Endpoint: https://api.dps.io/api
APIVersion: v1
route: jobs
path: recipients/<YOUR_JOB_HASH>

Method

GET

URL

https://api.dps.io/api/v1/jobs/recipients/Gd*****************EMo

Request Headers

{
  "Content-Type": "application/json",
  "x-api-key": "<YOUR_API_KEY>",
  "ShipperHash": "<YOUR_SHIPPER_HASH>"
}

Curl request

curl --location --request GET 'https://api.dps.io/api/v1/jobs/recipients/Gd*****************EMo' \
--header 'x-api-key: xxxxxxdfjbdjdfjdhfxxxxxxx' \
--header 'ShipperHash: 05K9****************************BJG6a'

Response

{
  "data": [
      {
        "Name": "John Doe",
        "Phone": "9876543210",
        "Email": "",
        "CompanyName": "try2code",
        "City": "PACIFIC GROVE",
        "State": "CA",
        "Zip": "93950",
        "Country": "United States",
        "AddressLine1": "585 OCEAN VIEW BLVD APT 7",
        "AddressLine2": " Apt 7",
        "RecipientHash": "1SUXe********************GX87e"
      },
      {
        "Name": "John Doe",
        "Phone": "9729729721",
        "Email": "test@dps.io",
        "CompanyName": "My Test Company 2",
        "City": "Placida",
        "State": "FL",
        "Zip": "33946",
        "Country": "US",
        "AddressLine1": "12575 Placida RD",
        "AddressLine2": "Plaicda",
        "RecipientHash": "3bZ9***************Wle9l"
      }
    ]
}