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

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES
page	The page number to return. Use together with limit to achieve paginated results	1	INTEGER	NO
limit	Determines how many results to return. Use together with page to achieve paginated results. Maximum here is 20000	20000	INTEGER	NO
order	Determines 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 first	od_DESC	STRING	NO
req_fields	Comma separated list of abbreviated fields to return in response.cid=contact_id, dn=display_name, comp=Company, em=Email, bphone=business_phone,as=assigned_status	cid,dn,comp,em,bphone,as	STRING	NO
contact_id	Returns the Contact with the specified Contact ID		STRING	NO
display_name	Returns the Contacts which contains the display name		STRING	NO
company	Returns the Contacts with the specified Company		STRING	NO
phone_number	Returns the Contacts with the specified Phone Number		STRING	NO
email	Returns the Contacts with the specified email		STRING	NO
output	Specifying XML or JSON returns data in XML or JSON format	XML	STRING	NO

Result¶

Error Result¶

HTTP Code	Error String	Resolution
400	API Version Empty	Add a value for the v parameter in the query string
400	API Version Invalid	Correct v parameter
400	Request Method must be GET. x attempted	Switch request method x to GET
400	Page Number not an integer	Remove non-numerics from page
400	Limit not an integer	Remove non-numerics from limit
400	Limit must be between 1 and 20000	Correct the limit parameter
400	Output Type Invalid	Correct output parameter
500	Internal Server Error	Retry 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>