Skip to main content
Server path: /getprospect | Type: Application | PCID required: Yes

Tools

ToolDescription
getprospect_company_controller_createCreate company
getprospect_company_controller_deleteDelete company
getprospect_company_controller_find_company_with_nameSearch companies
getprospect_company_controller_get_companyGet single company
getprospect_company_controller_updateUpdate company
getprospect_contact_controller_add_companies_to_contactAdd companies to contact
getprospect_contact_controller_createCreate contact
getprospect_contact_controller_deleteDelete contact
getprospect_contact_controller_get_contactGet single contact
getprospect_contact_controller_searchSearch contacts
getprospect_contact_controller_updateUpdate contact
getprospect_insights_controller_fast_search_contacts_and_companiesFast search through insight contacts and companies
getprospect_list_controller_add_contacts_to_listAdd contacts to list
getprospect_list_controller_create_listCreate new list
getprospect_list_controller_delete_listsDelete lists
getprospect_list_controller_get_list_contactsGet list contacts
getprospect_list_controller_get_listsGet lists
getprospect_list_controller_get_lists_countGet list size
getprospect_list_controller_update_listUpdate list
getprospect_properties_controller_find_allGet all properties
getprospect_public_api_company_enrich_v2controller_company_enrichCompany Enrich
getprospect_public_api_email_controller_public_find_emailFind Email
getprospect_public_api_email_controller_public_lookup_emailLookup Email
getprospect_public_api_email_controller_send_bounce_emailVerify Email
getprospect_public_api_email_v2controller_public_find_emailFind Email
getprospect_public_api_email_v2controller_verify_emailVerify Email
getprospect_public_api_insights_controller_get_contact_by_linked_inSearch lead by LinkedIn link
getprospect_public_api_insights_controller_public_search_companiesSearch companies
getprospect_public_api_insights_controller_public_search_contactsSearch leads

getprospect_company_controller_create

Create company Parameters:
ParameterTypeRequiredDefaultDescription
propertiesobject[]YesThe properties value

getprospect_company_controller_delete

Delete company Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringYesCompany id

getprospect_company_controller_find_company_with_name

Search companies Parameters:
ParameterTypeRequiredDefaultDescription
namestringNoCompany name string
limitnumberNoQuery limit

getprospect_company_controller_get_company

Get single company Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringYesCompany id

getprospect_company_controller_update

Update company Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringYesCompany id
propertiesobject[]YesThe properties value

getprospect_contact_controller_add_companies_to_contact

Add companies to contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesContact id
companiesobject[]YesThe companies value

getprospect_contact_controller_create

Create contact Parameters:
ParameterTypeRequiredDefaultDescription
listRelationsstring[]NoArray of list ids
propertiesobject[]YesThe properties value

getprospect_contact_controller_delete

Delete contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesContact id

getprospect_contact_controller_get_contact

Get single contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesContact id

Search contacts Parameters:
ParameterTypeRequiredDefaultDescription
includeCountbooleanNoincludes the amount of the contacts. The value “true” can slow down the performance of the request. Default - false.
pageSizenumberNohow many records to return per page (default 10, max 500)
pageNumbernumberNoan integer that allows you to paginate through the results (default 1)
sortstringNoa property to sort the contacts by
orderstringNocan be ASC or DESC
deletedbooleanNoReturns only deleted contacts if true. Default - false.
filtersobject[]NoThe filters value
includeRelationsbooleanNoIncludes companies, owner and lists in each of contacts. The value “true” can slow down the performance of the request. Default - false
includesstring[]NoCompany fields(domain, name and etc.)
searchIdstringNoSearch Id

getprospect_contact_controller_update

Update contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesContact id
listRelationsstring[]NoArray of list ids
propertiesobject[]Yescontact property you want to update

getprospect_insights_controller_fast_search_contacts_and_companies

Fast search through insight contacts and companies Parameters:
ParameterTypeRequiredDefaultDescription
searchstringYesThe search value
filtersobject[]NoThe filters value

getprospect_list_controller_add_contacts_to_list

Add contacts to list Parameters:
ParameterTypeRequiredDefaultDescription
liststringYesList id
contactsIdsstring[]NoContacts Ids

getprospect_list_controller_create_list

Create new list Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name value

getprospect_list_controller_delete_lists

Delete lists Parameters:
ParameterTypeRequiredDefaultDescription
listIdsstring[]YesArray of list ids. if payload is empty or its length equals zero, then all lists with status deleted will be removed forever

getprospect_list_controller_get_list_contacts

Get list contacts Parameters:
ParameterTypeRequiredDefaultDescription
liststringYeslist id
pageSizenumberNohow many records to return per page (default 10, max 500)
pageNumbernumberNoan integer that allows you to paginate through the results (default 1)
sortstringNoa property to sort the lists by
orderstringNocan be ASC or DESC

getprospect_list_controller_get_lists

Get lists Parameters:
ParameterTypeRequiredDefaultDescription
pageSizenumberNohow many records to return per page (default 10, max 500)
pageNumbernumberNoan integer that allows you to paginate through the results (default 1)
sortstringNoa property to sort the lists by
orderstringNocan be ASC or DESC

getprospect_list_controller_get_lists_count

Get list size Parameters:
ParameterTypeRequiredDefaultDescription
listIdsstring[]YesList Ids

getprospect_list_controller_update_list

Update list Parameters:
ParameterTypeRequiredDefaultDescription
listIdstringYesList id
namestringYesThe name value

getprospect_properties_controller_find_all

Get all properties

getprospect_public_api_company_enrich_v2controller_company_enrich

Company Enrich Parameters:
ParameterTypeRequiredDefaultDescription
idstringNoThe internal company ID (ObjectId).
linkedin_idnumberNoThe LinkedIn company ID (numeric).
linkedin_urlstringNoThe LinkedIn company URL (e.g. “https://linkedin.com/company/deloitte”).
domainstringNoThe company domain (e.g. “getprospect.com”).
namestringNoThe company name (e.g. “GetProspect”).

getprospect_public_api_email_controller_public_find_email

Find Email Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesthe contact’s full name (first name + last name).
companystringYescompany name or domain. Company domain increases the chances to find an email address.

getprospect_public_api_email_controller_public_lookup_email

Lookup Email Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesthe email address you want to lookup

getprospect_public_api_email_controller_send_bounce_email

Verify Email Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesthe email address you want to verify

getprospect_public_api_email_v2controller_public_find_email

Find Email Parameters:
ParameterTypeRequiredDefaultDescription
full_namestringNoThe contact’s full name (e.g. “Dmytro Shulha”). Use instead of first_name + last_name.
first_namestringNoThe contact’s first name (e.g. “Dmytro”). Required if full_name is not provided.
last_namestringNoThe contact’s last name (e.g. “Shulha”). Required when first_name is provided.
domainstringNoThe company domain (e.g. “getprospect.com”). Provides the best results.
companystringNoThe company name (e.g. “GetProspect”). Used as a fallback when domain is not provided.

getprospect_public_api_email_v2controller_verify_email

Verify Email Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesThe email address you want to verify.

getprospect_public_api_insights_controller_get_contact_by_linked_in

Search lead by LinkedIn link Parameters:
ParameterTypeRequiredDefaultDescription
linkedinUrlstringYescontact’s LinkedIn profile URL

getprospect_public_api_insights_controller_public_search_companies

Search companies Parameters:
ParameterTypeRequiredDefaultDescription
pageSizenumberNohow many records to return per page (default 10, max 500)
pageNumbernumberNoan integer that allows you to paginate through the results (default 1)
sortstringNoa property to sort the companies by
orderstringNocan be ASC or DESC
domainobjectNoThe domain value
employeesobjectNoThe employees value
industryobjectNoThe industry value
keywordsobjectNoThe keywords value
lastUpdatedstringNoLast Updated
locationobjectNoThe location value
nameobjectNoThe name value

getprospect_public_api_insights_controller_public_search_contacts

Search leads Parameters:
ParameterTypeRequiredDefaultDescription
pageSizenumberNohow many records to return per page (default 10, max 500)
pageNumbernumberNoan integer that allows you to paginate through the results (default 1)
sortstringNoa property to sort the leads by
orderstringNocan be ASC or DESC
companyNameobjectNoCompany Name
contactNameobjectNoContact Name
domainobjectNoThe domain value
emailstringNoThe email value
employeesobjectNoThe employees value
headquartersobjectNoThe headquarters value
industryobjectNoThe industry value
jobTitleobjectNoJob Title
keywordsobjectNoThe keywords value
lastUpdatedstringNoLast Updated
locationobjectNoThe location value
seniorityobjectNoThe seniority value