Request Parameters

Search Request Parameters

NameDescriptionOperators
profile_idThe ID of the profile to filter by.is, is not, is one of, is not one of, exists, does not exist
first_namesFirst names of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
last_namesLast names of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
emailsEmails of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
job_titlesJob titles of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
current_job_titlesCurrent job titles of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
previous_job_titlesPrevious job titles of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
current_job_functionsCurrent job functions level 1 of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
previous_job_functionsPrevious job functions level 1 of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
current_job_senioritiesCurrent job seniorities of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
previous_job_senioritiesPrevious job seniorities of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
profile_social_linksSocial links of profiles to filter byis, is not, is one of, is not one of, exists, does not exist
profile_social_link_namesSocial link names of profiles to filter byis, is not, is one of, is not one of, exists, does not exist
expertisesExpertises of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
company_namesNames of the current companies of profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
current_company_namesCurrent company names of the profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
previous_company_namesPrevious company names of the profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
profile_tagsProfile tags associated with the profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
contact_tagsContact tags associated with the profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
resume_tagsResume tags associated with the profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
keywordsKeywords found in various fields of the profiles to filter by.is, is not, is one of, is not one of, exists, does not exist
countriesCountries where the profiles are located to filter by.is, is not, is one of, is not one of, exists, does not exist
statesStates where the profiles are located to filter by.is, is not, is one of, is not one of, exists, does not exist
citiesCities where the profiles are located to filter by.is, is not, is one of, is not one of, exists, does not exist
completion_scoreCompleteness score of profiles to filter by.less than, greater than
last_modified_dateDate from which data are filtered.since, before

Search Query Boolean Logic

A OR operator is applied between the values of a parameter.
A AND operator is applied between parameters.

Search Query Settings

SettingsDescriptionValue
reveal_all_dataFor all offices that match the criteria:

When set to true
A complete response will be returned. One corpo record credit per office returned will be charged.

When set to false
A partial response will be returned. No credit will be charged.
Mandatory
page_sizeThe number [1, 100] of results to return in a single page.Optional.

The default is 20.
page_numberThe search results are paginated; this attribute specifies which page will be returned between [1, 100].Optional.

The default is 1.

Examples

{
    "parameters": {   
        "profile_id": [
            {
            "operator":"is one of",
            "value": ["prof-adco-7cc311bd50b8bb128b6e39db237ce38f", "prof-bdxp-4c06a914958a28fea22042fc0a929bf2"]
            }
        ]
    }
}
{
    "parameters": {   
        "first_names": [
            {
            "operator":"is one of",
            "value": ["John", "Kevin"]
            }
        ]
    }
}
{
    "parameters": {   
        "last_names": [
            {
            "operator":"is one of",
            "value": ["Snow", "Bacon"]
            }
        ]
    }
}
{
    "parameters": {   
        "emails": [
            {
            "operator":"is one of",
            "value": ["@aws.com", "@google.com"]
            }
        ]
    }
}
{
    "parameters": {   
        "job_titles": [
            {
            "operator":"is",
            "value": ["AWS Solution Architect"]
            }
        ]
    }
}
{
    "parameters": {   
        "last_modified_date": [
            {
            "operator": "since",
            "value": "2023-04-04"
            }
        ]
    }
}
{
    "parameters": {
        "emails": [
            {
                "operator": "exists",
                "value": null
            }
         ],
         "countries": [
            {
                "operator": "is one of",
                "value": ["Canada", "United Kingdom"]
            }
         ],
         "last_modified_date": [
            {
                "operator": "since",
                "value": "2023-04-04"
            }
         ]  
    }
}