GET GetContacts
Retrieves a list of contacts.
Input and output parameters
The input and output parameters for this method are:
*denotes required field.
| Input Parameter Name |
Type/Info |
| withfulldata* |
Expand additional data fields, provide boolean 1,0 |
| select |
Number of items to return, maximum 500. |
| skip |
Number of records to skip |
| status |
Filter by contact status: Active, Archived, Suppressed, Unsubscribed, DomainSuppression |
|
| Outputs: |
|
- id (unique identifier of contact, the id can be used to call another call getCustomFieldsForContact to list associated custom fields)
- email (the email address of the contact)
- opt_in_type (status of the opt in of the user, set to 0 for not opted in, 1 is opted in)
- email_type (the email type of the user)
- status (the status of the contact)
- first_name
- last_name
- name
- gender
- opt_in_date (the date the contact was opted in)
- post_code
|
Examples
curl --request POST \
--url https://api.wiredplus.com/v1/GetContacts?status=Active \
--header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
--form 'withfulldata=true' \
--form 'select=100' \
--form 'skip=10'
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.wiredplus.com/v1/GetContacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"\"\r\n\r\n\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"withfulldata\"\r\n\r\ntrue\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"select\"\r\n\r\n100\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"skip\"\r\n\r\n10\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
CURLOPT_HTTPHEADER => array(
"content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
var form = new FormData();
form.append("withfulldata", "true");
form.append("select", "100");
form.append("skip", "10");
var settings = {
"async": true,
"crossDomain": true,
"url": "https://api.wiredplus.com/v1/GetContacts",
"method": "POST",
"headers": {},
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
Result Format JSON
