GetContacts

Gets a list of all contacts in the account

This method returns a list of all contacts in your account.

The withFullData parameter can be set to 'true' to retrieve the contacts along with their full
contact data fields.

The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request.

The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set.

SOAP action: http://apiconnector.com/v2/ApiService/GetContacts

πŸ“˜

Input and output parameters

Input parameters

  • withFullData - optional; boolean
  • Select - optional; integer
  • Skip - optional; integer

Output parameters

  • GetContactsResult - array of contacts
    • Contact
      • Id - integer
      • Email - string
      • OptInType - string ('Unknown', 'Single', 'Double', 'VerifiedDouble')
      • EmailType - string ('PlainText', 'Html')
      • DataFields - optional; array of ContactData
        • ContactData
          • Key - string
          • Value - anyType
      • Status - string ('Subscribed', 'Unsubscribed', 'SoftBounced', 'HardBounced', 'IspComplained', 'MailBlocked', 'PendingOptIn', 'DirectComplaint', 'Deleted', 'SharedSuppression', 'Suppressed', 'NotAllowed', 'DomainSuppression', 'NoMxRecord')

Example

using (var client = new ApiServiceClient())
{
	client.ClientCredentials.UserName.UserName = "username";
	client.ClientCredentials.UserName.Password = "password";

	var withFullData = true;
	var select = 1000;
	var skip = 0;
	var contacts = client.GetContacts(withFullData, select, skip);
}