Request Parameters

Search Request Parameters

Name	Description	Operators
company_id	company_id of companies to filter by.	is, is not, is one of, is not one of, exists, does not exist.
office_id	office_id of companies to filter by.	is, is not, is one of, is not one of, exists, does not exist.
office_names	Office names of offices to filter by.	is, is not, is one of, is not one of, exists, does not exist.
tags	Tags associated with the offices to filter by.	is, is not, is one of, is not one of, exists, does not exist.
domains	Domain URLs of the offices you want to filter by.	is, is not, is one of, is not one of, exists, does not exist.
industries_names	Industries names associated with the offices to filter by.	is, is not, is one of, is not one of, exists, does not exist.
industries_codes	Industries codes associated with the offices to filter by.	is, is not, is one of, is not one of, exists, does not exist.
countries	Countries where the offices are located to filter by.	is, is not, is one of, is not one of, exists, does not exist.
states	States where the offices are located to filter by.	is, is not, is one of, is not one of, exists, does not exist.
cities	Cities where the offices are located to filter by.	is, is not, is one of, is not one of, exists, does not exist.
revenue_codes	Revenue range in USD of offices to filter by.	is, is not, is one of, is not one of, exists, does not exist.
employees_codes	Employees range of offices to filter by.	is, is not, is one of, is not one of, exists, does not exist.
last_modified_date	Date from which data are filtered by.	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
reveal_all_data	For 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_size	The number [1, 100] of results to return in a single page.	Optional. The default is 20.
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": {   
        "company_id": [
            {
            "operator":"exists",
            "value": null
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "office_id": [
            {
            "operator":"exists",
            "value": null
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "company_names": [
            {
            "operator":"is one of",
            "value": ["DOS SANTOS CARVALHO", "DG CONCEPT"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "names": [
            {
            "operator":"is one of",
            "value": ["DOS SANTOS CARVALHO", "DG CONCEPT"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "tags": [
            {
            "operator":"is one of",
            "value": ["Corporation", "Has Social Link"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "domains": [
            {
            "operator":"is one of",
            "value": ["apple.com", "google.com"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "industries_names": [
            {
            "operator":"is one of",
            "value": ["Home Furniture, Furnishings and Equipment Stores"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "industries_codes": [
            {
            "operator":"is one of",
            "value": ["57", "0291"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "countries": [
            {
            "operator":"is one of",
            "value": ["Canada", "United States"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "states": [
            {
            "operator":"is one of",
            "value": ["New York", "Berkshire"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "cities": [
            {
            "operator":"is one of",
            "value": ["New York City", "Wokingham"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "revenue_codes": [
            {
            "operator":"is one of",
            "value": ["1M - 2M", "100M - 500M"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "employee_codes": [
            {
            "operator":"is one of",
            "value": ["10 - 49","200 - 499"]
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {   
        "last_modified_date": [
            {
            "operator": "since",
            "value": "2022-10-30"
            }
        ]
    }
}

{
    "reveal_all_data": false,
    "parameters": {
        "domains": [
            {
                "operator": "exists",
                "value": null
            }
         ],
         "countries": [
            {
                "operator": "is one of",
                "value": ["Canada","United Kingdom"]
            }
         ],
         "last_modified_date": [
            {
                "operator": "since",
                "value": "2022-01-06"
            }
         ]  
    }
}