Get Recipient List Details

This API allows you to get the details of the recipients of a particular list.

Request Type

  • GET

Request URL

https://campaigns.zoho.com/emailapi/v1/recipients/{recipient_list_id}?start_index=1&end_index=1000

Content-Type

application/json

List of Request Parameters

ParametersData TypeDescription
start_indexIntegerStarting index of the number of objects to be obtained.
end_indexIntegerEnding index of the number of objects to be obtained.

List of Response Body Attributes

ParametersData TypeDescription
dataJSON ObjectContains information on the recipient list such as recipients, list name, total recipients, and description.
recipientsJSON ArrayContains the list of recipients and their details such as name, address, additional data and merge data if, any.
additional_dataJSON ObjectAdditional information of the recipient such as Country, Phone.
merge_dataJSON ObjectData to be replaced instead of merge tags.
nameStringName of the list.
countIntegerNumber of recipients present in the list.
descriptionStringDescription provided for the list.
responseJSON ObjectContains the response details of the API.
codeIntegerSuccess or failure code.
messageStringSuccess or failure message returned by the API.
rangeJSON ObjectContains information about start and end index.
start_indexIntegerStarting index of the data range being returned. Indicates the position in the overall data set where the returned data begins.
end_indexIntegerEnding index of the data range being returned. Indicates the position in the overall data set where the returned data ends.
errorsJSON ObjectContains the error details of the API such as 'code' and 'message'

Possible Errors

Error CodeDescription
400505No such recipient list.
Run in PostmanView Collection

Sample Response - Success

Copied{
  "data": {
    "recipients": [
      {
        "additional_data": {
          "country": "IN",
          "ph": "9876543210"
        },
        "address": "patricia@zylker.com",
        "name": "Patricia",
        "merge_data": {
          "first_name": "Patricia"
        }
      },
      {
        "additional_data": {
          "country": "IN",
          "ph": "1234567890"
        },
        "address": "boyle@zylker.com",
        "name": "Boyle",
        "merge_data": {
          "first_name": "Boyle"
        }
      },
      {
        "additional_data": {
          "country": "EU",
          "ph": "9999999999"
        },
        "address": "julia@zylker.com",
        "name": "Julia",
        "merge_data": {
          "first_name": "Julia"
        }
      },
      {
        "additional_data": {
          "country": "US",
          "ph": "9000000000"
        },
        "address": "jamal@zylker.com",
        "name": "Jamal",
        "merge_data": {
          "first_name": "Jamal"
        }
      },
      {
        "additional_data": {
          "country": "JP",
          "ph": "1111111111"
        },
        "address": "musashi@zylker.com",
        "name": "Musashi",
        "merge_data": {
          "first_name": "Musashi"
        }
      }
    ],
    "name": "List 4",
    "count": 5,
    "description": "List 4 test"
  },
  "response": {
    "code": 200502,
    "message": "Successfully obtained the recipient list details"
  },
  "range": {
    "start_index": 1,
    "end_index": 1000
  }
}

Sample Response - Failure

Copied{
  "errors": [
    {
      "code": 400505,
      "message": "No such recipient list"
    }
  ]
}