API Reference

Request Parameters

Request Parameter	DataType	Description	Example	Mandatory
jobTitle	String Array	Carries info of the job.	Ex: VP, Sales	False
pagination	Boolean	This field will controls the distribution of data across pages.	Ex: If this field is set to true data will be distributed across multiple pages. If this field is set to false (which is also a default value) data will be displayed in a single page (max of 10000 records).	False
max_contacts	Integer	This field is to specify the maximum no of contacts that are required.		False
page_size	Integer	This will be applicable only if Pagination is set to true and size of the page is calculated based on number of records required and number of pages required.		False
page_number	Integer	This is to specify the page number of required data present.		False
accuracy	String	This field specifies the accuracy of the contact data.	Ex: A+, A, A-, B	False(Default A+)
mode	String	There are two modes available Discover and Stats. Discover returns the data and Stats returns the count.		False(Default Discover)
company_guid	String	This field contains the GUID of the company.	Ex: E8932F31620C0D5D	True
location	String Array	This field allows you to specify the location of your contacts, including State, City, and Zipcode.	Ex: San Francisco, 94105	False
within_miles	Integer	Specify the desired search radius (from 1 – 100 miles) for your contacts in this field. This works in conjunction with the location field.	Ex: 50	False

Note : Max of 15 Job Titles can be sent in a single request.

Response Parameters

Response Parameter	Data Type	Description
contact_level	List<String>	Contact Job level will be available.
contact_function	List<String>	Contact Job function will be available.
contact_sub_function	List<String>	Contact job Sub function will be available.
contact_work_location_state	String	State of work location for contact will be available.
contact_guid	String	This field represents unique identification of contact.
contact_job_title	String	This field carries job title of the contact.
contact_work_location_address	String	This field contains contact work location address.
contact_work_location_city	String	Work location city name of the contact will be available.
contact_work_location_zipcode	String	Work location zip code of the contact will be available.
contact_work_location_country	String	Work location country of the contact will be available.

Response Codes

HTTP Status Code	Description	Error Message
200	ok
400	Bad Request	Invalid API Key.
400	Bad Request	Data missing: company_guid.
400	Bad Request	Invalid Data: mode.
400	Bad Request	page_number and page_size are mandatory fields to process pagination.
401	Unauthorized	API key inactive.
401	Unauthorized	Job title is not recognizable, please use another job title OR leave it blank to get all job titles.
406	NOT_ACCEPTABLE	API cannot return more than 10000 records.
406	NOT_ACCEPTABLE	page_size cannot be greater than 10000.
406	NOT_ACCEPTABLE	Only 15 job titles can be processed in a single call.
406	NOT_ACCEPTABLE	Max page_number for this query can be n.
412	PreCondition Failed	Contacts Not Found.
429	Too many Requests	Too Many Request Per Minute.
432	Bad Request	No contacts found matching your inputs, please try some different criteria.
433	NOT_ACCEPTABLE	Miles cannot be greater than 100.
434	Bad Request	Location and Within Miles are mandatory fields to process Location filter.
500	Internal Server Error	Unknown error occurred, try again later.