GetContacts

HYPER DRIVE PRO CRM - API REFERENCE
CONTACT FUNCTIONS / GETCONTACTS
For more information on our products and services please visit:
http://HyperDriveCRM.com  | http://RiderRewards.com | http://MoreThanRewards.com

Need help integrating with our products and services?
Give us a call at 414-326-4100 or email Support@MoreThanRewards.com/
Ask to speak to Jason Brethorst regarding API partnerships and integrations.  

WE HAVE AN API FOR JUST ABOUT ANYTHING
All More Than Rewards products are built using REST API architecture, therefore you'll be able to do ANYTHING within our products and services a REST call, you just need to know which one to use.  If there is something that your trying to do but are not clear just give Jason a call via his direct number at 414-467-6624 or speak to your account manager to learn more.

TEST SANDBOX API KEYS

SANDBOX ACCOUNT ID :  2175
SANDBOX API KEY :  1E7F03ACAEDE1CAD0C567DC14319821C

GetContacts

This API end point will search all contacts to see if they exisit in the database already.   You can lookup contacts by email, phone or ID with the Hyper Drive Pro CRM system by More Than Rewards.   For more information on HyperDrive CRM.    .  

Note About Duplicates:
This API will be used to determine of the contact exist already, if you find a match we recommend using the Contact ID to update the contact instead of adding the contact.  This will prevent duplicate data from appearing.

Rate Limiting and API Performance:
The intentions of this is to quickly look up a contact via phone or email, it is NOT designed to return a list of contacts or search for contacts.  You'll want to use the "SearchContact()" API if you wish to do that.  This API is really just designed to make easy to quickly lookup an existing contact and get their contactID so you can do an update on that contact vs a add to prevent duplicates. 

Post Url  - DO NOT USE GET - Use a POST

https://hyperdrivepro.morethanrewards.com/api/2/GetContacts.aspx

  • SSL is requred

Form Fields

Field
Max Length*
Required
Notes
response_type

No
Default results will be returned in XML. Set this field value to json to return results in JSON format  (as of Jan 1st 2018 we are disconnecting XML support, and moving to 100% json support instead, please use json when possible)
pagingsize

Strongly Recommended
Number of results to return per API call
* Starting Jan 1st this will be enforced to no more than 100 records per request.
pagingoffset

Strongly Recommended
Number of records to offset. (If your pagingsize was 100, then you’d offset 100 records on your second call to the API)
* Starting Jan 1st this will be enforced to no more than 100 records per request.
accountid

Yes
Must be numeric. Account ID for this account.
teammemberid

No
Must be numeric. ID of Team Member database that contact record belongs to. Leave blank for all account contacts.
apikey

Yes
API Key for this account. Found in Settings
contactid

No
Specify contact id using the database id. (Optional). If this contactid is left blank, all contacts for this account will be displayed.
email

No
Specify an email address.

Multiple matches will be returned if multiple contacts have the same email address.

phone

No
Specify a phone number. Searches all 4 contact phone number fields.

Multiple matches will be returned if multiple contacts have the same phone number.

adddateafter

No
Enter a date is US Date / Time Format   example:  4/24/2013 2:01PM

Only contacts added after the date given will be returned.

4/24/2013 assumes midnight, so anything added on or after 4/24/2013 would be included.

Time Zone for Add Date is US Central Time

aftereditdate

No
Enter a date is US Date / Time Format   example:  4/24/2013 2:01PM

Only Contacts edited after the date given will be returned.

4/24/2013 assumes midnight, so anything added on or after 4/24/2013 would be included.

Time Zone for Edit Date is US Central Time

* An error will not result if Max Length is exceeded. Data will be trimmed to this length.

Sample Results

Success Message (for 1 contact – not all fields displayed – blank fields are omitted from the results)

<results>
<contacts>
<contact>
<id>4302</id>
<accountid>2</accountid>
<firstname>Adam</firstname>
<lastname>Dalton</lastname>
<phone1>(707) 555-1234</phone1>
<phone1note>Cell</phone1note>
<email>test@email.com</email>
<adddate>10/26/2006 12:38:15 PM</adddate>
<editdate>10/26/2006 12:38:15 PM</editdate>
<inactive>False</inactive>
<category>
<id>2</id>
<name>HOT</name>
</category>
<flags>
<flag>
<id>576</id>
<name>High Value Prospect</name>
</flag>
</flags>
<referralcontactid>3233</referralcontactid>
</contact>
</contacts>
</results>      

Sample Failure Message

<?xml version="1.0"?> 
<results>     
<error>Authentication failed</error> 
</results>