Responses

Partial Company Search Response

When the request setting "reveal_all_data" is false, the company returned will not be charged against your credit balance.

Complete Company Search Response

When the request setting "reveal_all_data" is activated, each company returned will be charged as one corpo credit against your credit balance.

πŸ“˜

All counts provided in the counts node are an approximation of the number of records.

{
    "query": {
        "reveal_all_data": "boolean",
        "page_size": "integer",
        "page_number": "integer",
        "parameters": {
        }   
    },
    "counts": {
        "companies_total_results": "integer",
        "companies_total_returned": "integer",
        "offices_total_results": "integer",
        "offices_total_returned": "integer",
        "technologies_total_results": "integer",
        "technologies_total_returned": "integer",
        "profiles_total_results": "integer",
        "profiles_total_returned": "integer"
    },
    "results": [
        {
        "position": "integer",
        "company_data": {
            "company_last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
            "company_last_seen_date": "string (YYYY-MM-DD HH:MM:SS)",
            "company_id": "string",
            "company_name": "string",
            "company_domain": "string",
            "company_description": "string",
            "company_logo_url": "string",
            "company_type": "string",
            "company_number_of_offices": "integer",
            "company_number_of_detected_technologies": "integer",
            "company_number_of_profiles": "integer",
            "company_alternative_names": {
                "trade_names":["string"],
                "alias_names": ["string"],
                "previous_names": ["string"]
            },
            "company_phones": [
                {
                "phone": "string",
                "priority": "integer"
                }
            ],
            "company_web_address": {
                "url": "string"
            },
            "company_web_address_aliases": ["string"],
            "company_domain_aliases":  ["string"],
            "company_status": {
                "status": "string"
            },
            "company_employees": {
                "number_of_employees": "integer"
            },
            "company_financials": [
                {
                "yearly_revenue": {
                    "code": "string",
                    "currency": "string",
                    "year": "integer",
                    "reported_date": "string (YYYY-MM-DD)"
                    },
                "yearly_growth": {
                   "code": "string",
                   "year": "integer"
                },
                "priority": "integer"
                }
            ],
            "company_revenue_in_usd_code": "string",
            "company_industries": [
                {
                "id": "string",
                "code2": "integer",
                "name2": "string",
                "code3": "integer",
                "name3": "string",
                "code4": "integer",
                "name4": "string",
                "code5": "integer",
                "name5": "string",
                "code6": "integer",
                "name6": "string",
                "standard": "string",
                "activity_priority": "integer",
                "priority": "integer"
                }
            ],
            "company_primary_address": {
                "continent": "string",
                "country": "string",   
                "county": "string",
                "state": "string",
                "city": "string"
            }
        },
        "company_detected_technologies": [
            {
            "technology_product": {
                "name": "string",
                "logo_url": "string"
            },
            "technology_vendor": {
                "name": "string",
                "logo_url": "string"
            },
            "technology_category": {
                "code2": "integer",
                "name2": "string"
            },
            "technology_tags": ["string"],
            "technology_display_popularity": "integer"
            }
        ]
        }
    ],
    "pagination": {
        "current": "integer",
        "next_page": "integer",
        "last_page": "integer"
    },
    "transaction_detail": {
        "id": "string",
        "account_number": "string",
        "account_type": "string",
        "product_name": "string",
        "endpoint": "string",
        "corpo_record_credits_used": "integer",
        "corpo_record_credits_available": "integer",
        "execute_at": "string (YYYY-MM-DD HH:MM:SS)",
        "total_time_taken": "decimal"
    }
}
{
    "query": {
        "reveal_all_data": "boolean",
        "page_size": "integer",
        "page_number": "integer",
        "parameters": {
        }   
    },
    "counts": {
        "companies_total_results": "integer",
        "companies_total_returned": "integer",
        "offices_total_results": "integer",
        "offices_total_returned": "integer",
        "technologies_total_results": "integer",
        "technologies_total_returned": "integer",
        "profiles_total_results": "integer",
        "profiles_total_returned": "integer"
    },
    "results": [
        {
        "position": "integer",
        "company_data": {
            "company_last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
            "company_last_seen_date": "string (YYYY-MM-DD HH:MM:SS)",
            "company_id": "string",
            "company_name": "string",
            "company_domain": "string",
            "company_description": "string",
            "company_logo_url": "string",
            "company_type": "string",
            "company_number_of_offices": "integer",
            "company_number_of_detected_technologies": "integer",
            "company_number_of_profiles": "integer",
            "company_alternative_names": {
                "trade_names":["string"],
                "alias_names": ["string"],
                "previous_names": ["string"]
            },
            "company_phones": [
                {
                "phone": "string",
                "ddi": "boolean",
                "dnc": "boolean",
                "type": "string",
                "carrier": "string",
                "priority": "integer"
                }
            ],
            "company_emails": [
                {
                "email": "string",
                "priority": "integer"
                }
            ],
            "company_web_address": {
                "url": "string",
                "rank": "integer"
            },
            "company_web_address_aliases": ["string"],
            "company_domain_aliases":  ["string"],
            "company_social_links": {
                "linkedin": {
                    "url": "string"
                },
                "twitter": {
                    "url": "string"
                },
                "facebook": {
                    "url": "string"
                },
                "instagram": {
                    "url": "string"
                },
                "youtube": {
                    "url": "string"
                },
                "yelp": {
                    "url": "string"
                },
                "crunchbase": {
                    "url": "string"
                }
            },
            "company_tags": ["string"],
            "company_national_registration": {
                "name": "string",
                "number": "string"
            },
            "company_profile": {
                "date_founded": "string (YYYY-MM-DD)",
                "date_closed": "string (YYYY-MM-DD)",
                "fortune500_rank": "integer",
                "entity_type": "string",
                "ownership_type": "string",
                "new_business": "boolean",
                "publicly_traded": "boolean",
                "small_business": "boolean",
                "marketable": "boolean"
            },
            "company_status": {
                "status": "string"
            },
            "company_employees": {
                "number_of_employees": "integer",
                "number_of_employees_code": "string"
            },
            "company_financials": [
                {
                "yearly_revenue": {
                    "revenue": "float",
                    "code": "string",
                    "currency": "string",
                    "year": "integer",
                    "reported_date": "string (YYYY-MM-DD)",
                    "type": "string"
                    },
                "yearly_growth": {
                   "percentage": "float",
                   "code": "string",
                   "type": "string",
                   "year": "integer"
                },
                "priority": "integer"
                }
            ],
            "company_revenue_in_usd": "float",
            "company_revenue_in_usd_code": "string",
            "company_industries": [
                {
                "id": "string",
                "code2": "string",
                "name2": "string",
                "code3": "string",
                "name3": "string",
                "code4": "string",
                "name4": "string",
                "code5": "string",
                "name5": "string",
                "code6": "string",
                "name6": "string",
                "standard": "string",
                "activity_priority": "integer",
                "priority": "integer"
                }
            ],
            "company_stock_exchanges": [
                {
                "ticker": "string",
                "name": "string",
                "exchange": "string",
                "index": "string",
                "country_code": "string",
                "market_valuation": "float",
                "market_valuation_currency": "string",
                "entry_date": "string (YYYY-MM-DD)",
                "exit_date": "string (YYYY-MM-DD)"
                }
            ],
            "company_primary_address": {
                "last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
                "formatted_address": "string",
                "street_address":  "string",
                "place_id": "string",
                "lat": "float",
                "lng": "float",
                "accuracy": "string",
                "confidence_score": "integer",
                "quality": "string",
                "administrative_area_level_1": "string",
                "administrative_area_level_2": "string",
                "administrative_area_level_3": "string",
                "administrative_area_level_4": "string",
                "administrative_area_level_5": "string",
                "continent": "string",
                "country": "string",
                "country_code": "string",
                "establishment": "string",
                "locality": "string",
                "postal_code": "string",
                "postal_town": "string",
                "premise": "string",    
                "county": "string",
                "state": "string",
                "city": "string",
                "street": "string",
                "street_number": "string",
                "sublocality": "string",
                "subpremise": "string",
                "score": "float"
            }
        },
        "company_detected_technologies": [
            {
            "technology_first_detected_date": "string (YYYY-MM-DD)",
            "technology_last_detected_date": "string (YYYY-MM-DD)",
            "technology_behind_firewall": "boolean",
            "technology_product": {
                "id": "integer",
                "name": "string",
                "url": "string",
                "logo_url": "string"
            },
            "technology_vendor": {
                "id": "integer",
                "name": "string",
                "url": "string",
                "logo_url": "string"
            },
            "technology_category": {
                "id": "integer",
                "code2": "integer",
                "name2": "string",
                "code3": "integer",
                "name3": "string",
                "code4": "integer",
                "name4": "string"
            },
            "technology_tags": ["string"],
            "technology_display_popularity": "integer"
            }
        ],
        "company_metrics": {
            "marketability_score": "float",
            "completion_score": "float"
        }
    }
    ],
    "pagination": {
        "current": "integer",
        "next_page": "integer",
        "last_page": "integer"
    },
    "transaction_detail": {
        "id": "string",
        "account_number": "string",
        "account_type": "string",
        "product_name": "string",
        "endpoint": "string",
        "corpo_record_credits_used": "integer",
        "corpo_record_credits_available": "integer",
        "execute_at": "string (YYYY-MM-DD HH:MM:SS)",
        "total_time_taken": "float"
    }
}

What’s Next