Retrieve profile list members using query attribute (HA Retrieve List Members)
Use the interface to retrieve members of a Profile List, by using query attributes.
Service URL:
/rest/haApi/v1.3/lists/{listName}
Required Path Parameters:
listName - Name of the profile list from which you want to retrieve members.
Optional Path Parameters:
qa - Query attribute. Can be either 'r' (RIID_), 'e' (EMAIL_ADDRESS_), 'c' (CUSTOMER_ID_), or 'm' (MOBILE_NUMBER_).
fs - Comma-separated list of fields to retrieve, or use all to retrieve all fields.
id - ID corresponding to the query attribute.
Request Method:
GET
Request URL Example:
The following request URL example requests the values of the and EMAIL_ADDRESS_ fields for a member of the ExampleList profile list whose EMAIL_ADDRESS_ is test@example.com.
/rest/haApi/v1.3/lists/ExampleList?qa=e&fs=EMAIL_ADDRESS_,RIID_&id=test@example.com
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Response Body Properties:
fieldNames - Array of field names in the Profile List that were passed in the request using the fs parameter.
records - Array of field values returned in the query. Each element in the array represents a single Profile List member.
fieldValues - Array of Profile List field values (as specified using the fs parameter) for the recipient found using the query criteria.
mapTemplateName - The Map Template in Responsys that can be used to map Field Names of the Profile List to Column Names.
Sample Response:
In the following response body example, the query shown in the “Request URL Example” section (above) found one record in the ExampleList profile list for the email address test@example.com. Because the fs parameter requested the EMAIL_ADDRESS_ and RIID_ for any list members found, those columns are listed in the fieldNames array, and the values for the record found are returned in the fieldValues array (contained in the records array).
{
"fieldNames": [
"EMAIL_ADDRESS_",
"RIID_"
],
"records": [
{
"fieldValues": [
"test@example.com",
"3001221"
]
}
],
"mapTemplateName": null
}