Request Parameters

Search Request Parameters

Name	Description	Operators
profile_id	The ID of the profile to filter by.	is, is not, is one of, is not one of, exists, does not exist
first_names	First names of profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
last_names	Last names of profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
emails	Emails of profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
job_titles	Job titles of profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
current_job_titles	Current job titles of profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
previous_job_titles	Previous job titles of profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
current_job_functions	Current 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_functions	Previous 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_seniorities	Current job seniorities of profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
previous_job_seniorities	Previous job seniorities of profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
profile_social_links	Social links of profiles to filter by	is, is not, is one of, is not one of, exists, does not exist
profile_social_link_names	Social link names of profiles to filter by	is, is not, is one of, is not one of, exists, does not exist
expertises	Expertises of profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
company_names	Names 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_names	Current company names of the profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
previous_company_names	Previous company names of the profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
profile_tags	Profile tags associated with the profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
contact_tags	Contact tags associated with the profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
resume_tags	Resume tags associated with the profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
keywords	Keywords found in various fields of the profiles to filter by.	is, is not, is one of, is not one of, exists, does not exist
countries	Countries where the profiles are located to filter by.	is, is not, is one of, is not one of, exists, does not exist
states	States where the profiles are located to filter by.	is, is not, is one of, is not one of, exists, does not exist
cities	Cities where the profiles are located to filter by.	is, is not, is one of, is not one of, exists, does not exist
completion_score	Completeness score of profiles to filter by.	less than, greater than
last_modified_date	Date 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

Settings	Description	Value
page_size	The number [1, 100] of results to return in a single page.	Optional. The default is 20.
reveal_all_data	For all offices that match the criteria: When set to true A complete response will be returned. One profile record credit per profile returned will be charged. When set to false A partial response will be returned. No credit will be charged.	Mandatory
page_number	The search results are paginated; this attribute specifies which page will be returned between [1, 100].	Optional. The default is 1.

Examples

{
  "reveal_all_data": false,
  "parameters": {   
        "profile_id": [
            {
            "operator":"is one of",
            "value": ["prof-adco-7cc311bd50b8bb128b6e39db237ce38f", "prof-bdxp-4c06a914958a28fea22042fc0a929bf2"]
            }
        ]
    }
}

{
  "reveal_all_data": false, 
  "parameters": {   
        "first_names": [
            {
            "operator":"is one of",
            "value": ["John", "Kevin"]
            }
        ]
    }
}

{
  "reveal_all_data": false, 
  "parameters": {   
        "last_names": [
            {
            "operator":"is one of",
            "value": ["Snow", "Bacon"]
            }
        ]
    }
}

{
  "reveal_all_data": false, 
  "parameters": {   
        "emails": [
            {
            "operator":"is one of",
            "value": ["@aws.com", "@google.com"]
            }
        ]
    }
}

{
  "reveal_all_data": false,
  "parameters": {   
        "job_titles": [
            {
            "operator":"is one of",
            "value": ["AWS Solution Architect"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "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"
            }
         ]  
    }
}