getContacts

Request Method: GET

Description: Retrieves a list of all contacts

URL: https://api.iovox.com:444/Contacts?v=3&method=getContacts

The following parameters can be sent in the querystring

ParameterDescriptionDefault ValueData TypeMandatory
vAPI version to use
INTEGERYES
pageThe page number to return. Use together with limit to achieve paginated results1INTEGERNO
limitDetermines how many results to return. Use together with page to achieve paginated results. Maximum here is 2000020000INTEGERNO
orderDetermines which field to order the output result by. Use a field name from the req_fields list and suffix with _ASC or _DESC for ascending or descending respectively. For example, "od_DESC" will return results ordered by order_date with the most recent firstod_DESCSTRINGNO
req_fieldsComma separated list of abbreviated fields to return in response.cid=contact_id, dn=display_name, comp=Company, em=Email, bphone=business_phone,as=assigned_statuscid,dn,comp,em,bphone,asSTRINGNO
contact_idReturns the Contact with the specified Contact ID
STRINGNO
display_nameReturns the Contacts which contains the display name
STRINGNO
companyReturns the Contacts with the specified Company
STRINGNO
phone_numberReturns the Contacts with the specified Phone Number
STRINGNO
emailReturns the Contacts with the specified email
STRINGNO
outputSpecifying XML or JSON returns data in XML or JSON format XMLSTRINGNO

Result

Error Result

HTTP CodeError StringResolution
400API Version EmptyAdd a value for the v parameter in the query string
400API Version InvalidCorrect v parameter
400Request Method must be GET. x attemptedSwitch request method x to GET
400Page Number not an integerRemove non-numerics from page
400Limit not an integerRemove non-numerics from limit
400Limit must be between 1 and 20000Correct the limit parameter
400Output Type InvalidCorrect output parameter
500Internal Server ErrorRetry later

Success Result

<?xml version="1.0" encoding="utf-8"?>
<response>
     <current_page>1<current_page>
     <total_pages>4<total_pages>
     <total_results>100<total_results>
     <results>
         <result>
             <contact_id>2</contact_id>
             <display_name>James Smith</display_name>
             <company>IOVOX</company>
             <email>james@iovox.com</email>
             <business_phone>442272099107</business_phone>
             <assigned_status>ASSIGNED</assigned_status>
         </result>
         <result>
             ...
         <result>
     </results>
 </response>