Contact_Get

Contact_Get( string keystring emailoptional struct optionalParameters)
 

Note: When using one of the API wrappers, you do not need to pass the API key. The wrapper will pass the key for you, your first parameter should be the second parameter in the signature.

Description

Get information on a single contact.
 

Parameters

  string key Your API key - used to authenticate your account
  string email The email address of the contact you want information for
optional struct optionalParameters A struct of optional parameters, see below for valid keys

optionalParameters can include:

array customFields Array of custom field IDs or tokens you want included with the results (ex: ['first_name','last_name','email_address'] OR [1,2,3])
bool getAllCustomFields As optionalParameter customFields, but automatically includes all custom fields. Overrides customFields value

Return

struct Returns a struct of structs, keyed off of email address, each containing the keys specified above

Return structure will include:

int contactId The Contact ID for each contact
string email The email address for each contact
string status The status for each contact
string source The source of each contact
various * Any custom fields you specified via optionalParameters  

Still need help? Contact Us Contact Us