Follow

Get All Contacts in List

The Get All Contacts in List command allows you to get a list of all Contacts in the Realm who are subscribed to the List.

GET /lists/[listId]/subscribers

https://[siteurl]/rest/lists/[listId]/subscribers

Request Body Parameters

The Get All Contacts in List command requires the URI call with the List ID and contacts parameter. No additional fields are required in the JSON.    

Request Body Example

Using Get All Contacts in List:

curl --request GET \ 
--url 'https://mail.mydomain.com/rest/lists/10/subscribers' \
--header 'authorization: Basic bXlBY2NvdW50Onh5enB3ZDEyMw==' \
--header 'accept: application/vnd.whatcounts-v1+json' \
--header 'content-type: application/json' \
--include

Response Body

The response returns all API available Contact data in JSON format for each Contact in the List.  If more than 500 results are found, the first 500 are displayed, and you must use the "skip" value to view the next 500.  

For example, to find the three groups of 500 Contacts in a List with 1455 Contacts, the URIs would be formatted as:

  1. https://[siteurl]/rest/lists/[listId]/subscribers?skip=0
  2. https://[siteurl]/rest/lists/[listId]/subscribers?skip=500
  3. https://[siteurl]/rest/lists/[listId]/subscribers?skip=1000

For more information about "skip", see Pagination.

Based on the example above, and two Contacts in the List, the response returns the following.  NOTE: this command does NOT return Contact Custom Data.  To retrieve Custom Data, please use the Contact Management resources to Get Contact.

HTTP/1.1 200 OK
Server: serverName
Content-Type: application/json
Link: <https://mail.mydomain.com/rest/lists/10/subscribers>;
Date: Fri, 17 Jun 2016 12:54:44 GMT
{
"subscriberId": 7160984
"realmId": 1561
"email": "jon.doe@mydomain.com"
"firstName": "Jon"
"lastName": "Doe"
"company": "My Company"
"address1": "123 Some Street North"
"address2": "Suite 500"
"city": "My City"
"state": "WA"
"zip": "98000"
"country": "United States"
"phone": "(206) 555 1212"
"fax": ""
"createdDate": "May 21, 2012 9:14:16 AM"
"updatedDate": "Nov 2, 2015 10:31:27 AM"
"ipAddress": ""
"md5Encryption": "C8ADED17D5F088E8262BF31ED933B7D4"
"sha1Encryption": "356B1860247728C81486A35062688F302D96C2D1"
"skip": 1
"max": 0
}
{
"subscriberId": 25158866
"realmId": 1561
"email": "jane.doe@mydomain.com"
"firstName": "Jane"
"lastName": ""
"company": ""
"address1": ""
"address2": ""
"city": ""
"state": ""
"zip": ""
"country": ""
"phone": ""
"fax": ""
"createdDate": "May 4, 2015 9:48:33 AM"
"updatedDate": "Jun 13, 2016 1:06:46 PM"
"md5Encryption": "5EBD1AAAEA76811129331B0FA649F48C"
"sha1Encryption": "811B2A6ADC716AFFF1127A7B27D2F7B81167AB2E"
"skip": 0
"max": 0
}

Error Response

Error Response Codes include both Client Errors (4xx) and Server Errors (5xx).  Descriptions of each can be found in Response Codes

For example, if the Authorization is incorrect, the error would appear as:

{
"error": "Unauthorized"
"status": "Unauthorized"
"statusCode": 401
}

 

Was this article helpful?
0 out of 1 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk