Retrieve the data from one user's custom fields.

JSON Request Example:       

  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Subscribers",
  "requestmethod": "GetSubscriberCustomFields",
  "details": {
    "subscriberid": "{*subscriber_id*}", /* required */
    "list": "{*list_id*}", /* required */
    "customfield": "{*comma_separated_list_of_custom_field_ids*}"

 "json_request"  element

Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account

Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. For example, if no "customfield" value is inserted, the "customfield" tags should be deleted. 

<details> element

Field NameDescription
ID of a subscriber in the list
ID of list contact is in
customfieldComma-separated list of custom field IDs. NOTE: while technically
not required for a successful API return response, user MUST specify
the custom field ID they wish to retrieve data for.

*To get subscriber id, go to Contacts => Manage Databases => View Contacts.

Hover cursor over one of the links to the right of the contact, such as 'View'.

Note the number at the end of the URL after the '=' at the bottom of the browser window. 

That number is the 'subscriber ID'.

Successful Response:

"response" element

Field NameDescription
statusWill return SUCCESS if subscriber and list successfully found


"item" element

Field NameDescription
fieldidID number of custom field
fieldnameName of custom field
fieldtypeData type of field
fieldsettingsSerialized version of the custom field's settings
subscriberidID of the subscriber
dataThe value of the custom field for this subscriber

Unsuccessful Response:

"response" element

Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed