Get Recipient Lists

This API allows you to get the Lists in which your recipients are present.

Request Type

Request URL

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

Content-Type

application/json

List of Request Parameters

Parameters	Data Type	Description
start_index	Integer	Starting index of the number of objects to be obtained.
end_index	Integer	Ending index of the number of objects to be obtained.

List of Response Body Attributes

Parameters	Data Type	Description
data	JSON Array	Contains information on the recipient lists configured, including their name, ID and description.
name	String	Name of the list.
description	String	Description provided for the list.
id	Integer	Unique ID of the list which can be used in APIs.
count	Integer	Total number of lists returned.
range	JSON Object	Contains information about start and end index.
start_index	Integer	Starting index of the data range being returned. Indicates the position in the overall data set where the returned data begins.
end_index	Integer	Ending index of the data range being returned. Indicates the position in the overall data set where the returned data ends.
errors	JSON Object	Contains the error details of the API such as 'code' and 'message'
code	Integer	Success or failure code.
message	String	Success or failure message returned by the API.

Run in Postman View Collection

Sample Response - Success

Copied{
  "data": [
    {
      "name": "List 4",
      "description": "List 4 test",
      "id": "8000000097065"
    },
    {
      "name": "List 5",
      "description": "List 4 test",
      "id": "8000000098001"
    }
  ],
  "count": 2,
  "range": {
    "start_index": 1,
    "end_index": 1000
  }
}

Sample Response - Failure

Copied{
  "errors": [
    {
      "code": 500501,
      "message": "An error occurred in Recipient List API"
    }
  ]
}