Request Parameters

Search Request Parameters

Name	Description	Operators
profile_id	profile_id of contacts to filter by.	includes, excludes
contact_id	contact_id of contacts to filter by.	includes, excludes
first_name	First name of contacts to filter by.	includes, excludes
last_name	Last name of contacts to filter by.	includes, excludes
email	Email associated with the contacts to filter by.	includes, excludes
job_title	Job Title associated with the contacts to filter by.	includes, excludes
job_function	Job Function associated with the contacts to filter by.	includes, excludes
job_seniority	Job Seniority associated with the contacts to filter by.	includes, excludes
social_link	Social Links associated with the contacts to filter by.	includes, excludes
social_link_name	Social Links Names associated with the contacts to filter by.	includes, excludes
expertise	Expertises of contacts to filter by.	includes, excludes
company_name	Name of the current company of contacts to filter by.	includes, excludes
industry_name	Name of the company_industries of contacts to filter by.	includes, excludes
industry_standard	Standard of the company_industries of contacts to filter by.	includes, excludes
industry_code	Code of the company_industries of contacts to filter by.	includes, excludes
keywords	Keywords found in various fields of the contacts to filter by.	includes, excludes
region	UK Region where the contacts are located to filter by.	includes, excludes
country	Country where the contacts are located to filter by.	includes, excludes
state	State where the contacts are located to filter by.	includes, excludes
city	City where the contacts are located to filter by.	includes, excludes
county	County where the contacts are located to filter by.	includes, excludes
postal_code	Postal code where the contacts are located to filter by.	includes, excludes
office_type	Office Type of the current office of contacts to filter by.	includes, excludes
company_id	company_id of contacts to filter by.	includes, excludes
phone	Company Phone or Contact Phones of contacts to filter by.	includes, excludes

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 contacts that match the criteria: When set to true A complete response will be returned. One contact record credit per contact 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.

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 contacts that match the criteria:

When set to true
A complete response will be returned. One contact record credit per contact 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

{
    "parameters": {
        "contact_id": [
            {
                "operator": "includes",
                "value": [
                    "cont-shli-93e0cd9ef1cef51120c8d3f040db7a80"
                ]
            }
        ]
    },
    "reveal_all_data": false
}

{
    "parameters": {
        "first_name": [
            {
                "operator": "includes",
                "value": [
                    "john"
                ]
            }
        ]
    },
    "reveal_all_data": false
}

{
    "parameters": {
        "last_name": [
            {
                "operator": "includes",
                "value": [
                    "john"
                ]
            }
        ]
    },
    "reveal_all_data": false
}

{
    "parameters": {
        "email": [
            {
                "operator": "includes",
                "value": [
                    "[email protected]",
                    "[email protected]"
                ]
            }
        ]
    },
    "reveal_all_data": false
}

{
    "parameters": {
        "industry_name": [
            {
                "operator": "includes",
                "value": [
                    "Marketing Consulting Services",
                    "Administration of financial markets"
                ]
            }
        ]
    },
    "reveal_all_data": false
}

{
    "parameters": {
        "job_function": [
            {
                "operator": "includes",
                "value": [
                    "General Management",
                    "Administration"
                ]
            }
        ]
    },
    "reveal_all_data": false
}

{
    "parameters": {
        "job_function": [
            {
                "operator": "includes",
                "value": [
                    "administration"
                ]
            }
        ],
        "country": [
            {
                "operator": "includes",
                "value": [
                    "United Kingdom"
                ]
            }
        ],
        "industry_name": [
            {
                "operator": "includes",
                "value": [
                    "Construction"
                ]
            }
        ]
    }
}