Difference between revisions of "API:Contacts:Find"

From docs
Jump to: navigation, search
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
  
== Find Contacts ==
+
== [[API]] » Find Contacts ==
  
'''URL:''' <nowiki>https://app.callproof.com/contacts/find/</nowiki>
+
'''URL:''' <nowiki>https://app.callproof.com/api/contacts/find/</nowiki>
  
 
'''Method:''' GET
 
'''Method:''' GET
Line 19: Line 19:
 
* '''''state'''''' - Query by state name (e.g. 'TN')
 
* '''''state'''''' - Query by state name (e.g. 'TN')
 
* '''''zip''''' - Query by zip code (e.g. 37015)
 
* '''''zip''''' - Query by zip code (e.g. 37015)
 +
* '''''account''''' - Query by account (e.g. 123456)
 
* '''''query''''' - Query company name, contact phone number, contact first or last name, email, or address by keyword (e.g. 'plumber')
 
* '''''query''''' - Query company name, contact phone number, contact first or last name, email, or address by keyword (e.g. 'plumber')
 +
  
 
'''Data Returned:'''
 
'''Data Returned:'''

Latest revision as of 09:31, 27 May 2019

API » Find Contacts

URL: https://app.callproof.com/api/contacts/find/

Method: GET

Required Fields:

  • key - API Key
  • secret - API Key Secret

Optional Fields:

  • offset - Only 10 Contacts are returned per request, this field must be used to pull additional results when more are available
  • assigned - Query for assigned Contacts (e.g. 't', 'T', 'f', 'F')
  • contact_type - Query by your custom Contact Type name (https://app.callproof.com/contact_types/)
  • city' - Query by city name (e.g. 'Nashville')
  • state' - Query by state name (e.g. 'TN')
  • zip - Query by zip code (e.g. 37015)
  • account - Query by account (e.g. 123456)
  • query - Query company name, contact phone number, contact first or last name, email, or address by keyword (e.g. 'plumber')


Data Returned:

  • results - Array of Contacts
  • more - This field will be set if additional results are available
  • offset - Current offset of the request
  • errors - Array of errors produced by the request
  • code - HTTP request status