Retrieve a member of a profile list based on query attribute

Existing members of a profile list can be retrieved one at a time by using a query attribute if the Responsys ID (RIID) for the member is not available.

REQUEST NOTES:

• The total length of the string passed in for the fs parameter (containing the comma separated field names) cannot exceed 150 characters.
• To retrieve values of all columns, you can specify only one field with value set to ‘all’ (if you have a column called ‘all’, you should use two or more specific column names to avoid getting all of the columns).

Service URL:

/rest/api/v1.3/lists/{listName}/members

Request Method:

GET

Request Header:

Authorization=<AUTH_TOKEN>

Request parameters:

• qa – Query Attribute. Can be one of the following values:

  • ‘r’ – RIID
  • ‘e’ – EMAIL_ADDRESS
  • ‘c’ – CUSTOMER_ID
  • ‘m’ – MOBILE_NUMBER
• id – ID corresponding to the query attribute
• fs – Comma separated field list or ‘all’

Request Body:

None

Sample Response in case of success:

RESPONSE NOTE: Other attributes in the response like mapTemplateName and mergeRule will have default values of null/false.

{
   "recordData":    {
      "fieldNames":       [
         "RIID_",
         "EMAIL_ADDRESS_",
         "CUSTOMER_ID_"
      ],
      "records":       [
         [
            "4094330",
            "ab.na@gmail.com",
            null
         ],
         [
            "4094326",
            "ab.cd@gmail.com",
            null
         ]
      ],
      "mapTemplateName": null
   },
   "mergeRule":    {
      "textValue": null,
      "insertOnNoMatch": false,
      "updateOnMatch": null,
      "matchOperator": null,
      "matchColumnName3": null,
      "matchColumnName1": null,
      "matchColumnName2": null,
      "optinValue": null,
      "optoutValue": null,
      "rejectRecordIfChannelEmpty": null,
      "htmlValue": null,
      "defaultPermissionStatus": null
   },
   "links":    [
      {
         "rel": "self",
         "href": "/rest/api/v1.3/lists/DemoNewsLetterList/members?qa=m&fs=riid_,email_address_,customer_id_&id=9845349498",
         "method": "GET"
      },
      {
         "rel": "mergeListRecipients",
         "href": "/rest/api/v1.3/lists/DemoNewsLetterList/members",
         "method": "POST"
      }
   ]
}

Sample Response in case of failure:

{
   "type": "",
   "title": "Invalid field name",
   "errorCode": "INVALID_FIELD_NAME",
   "detail": "Column(s) [CUSTOMER_ID] not found in the list",
   "errorDetails": []
}