API:Contacts:Find

From docs
Jump to: navigation, search

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)
  • 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