enrichment

Search companies by filters

Changed on
post/v1/search/companies

Request

Request body

signalIdsnumber[]
newsIdsnumber[]
type'Privately Held' | 'Public Company' | 'Self-Owned' | 'Self-Employed' | 'Partnership' | 'Nonprofit' | 'Educational' | 'Government Agency'
is_b2bboolean
ownership_status'Private' | 'Public' | 'Other'
pagenumber
tab'total' | 'netNew'

Which results to search. netNew returns only leads/companies not yet revealed by your account; total returns all matches, including ones you have already revealed.

Example request

{
  "signalIds": [
    2,
    3,
    4
  ],
  "newsIds": [
    2,
    4,
    7
  ],
  "type": "Privately Held",
  "is_b2b": true,
  "employee_count_seniority": [
    {
      "group": "owner",
      "count": {
        "min": "1",
        "max": "5"
      }
    },
    {
      "group": "vp",
      "count": {
        "min": "3",
        "max": "15"
      }
    }
  ],
  "employee_count_department": [
    {
      "group": "medical",
      "count": {
        "min": "5",
        "max": "50"
      }
    },
    {
      "group": "sales",
      "count": {
        "min": "10",
        "max": "100"
      }
    }
  ],
  "base_salary": [
    {
      "title": {
        "includes": [
          "utility sales and service manager"
        ],
        "excludes": [],
        "exactMatch": 0
      },
      "range": {
        "min": "30000",
        "max": "50000"
      }
    }
  ],
  "ownership_status": "Private",
  "look_alike_company_name": [
    {
      "value": "hubspot.com"
    },
    {
      "value": "Salesforce"
    }
  ],
  "visits_breakdown_by_country": [
    {
      "country": "United States",
      "percentage": {
        "min": "20",
        "max": "60"
      }
    }
  ],
  "visits_breakdown_by_gender": [
    {
      "gender": "female",
      "percentage": {
        "min": "30",
        "max": "70"
      }
    }
  ],
  "page": 1,
  "tab": "netNew"
}

Response

Companies searched successfully

OR

Example response

{
  "message": "Success"
}

Changes

    • breaking

      added to the request property allOf list

    • warning

      removed from the request property allOf list

    • info

      added the new optional request property

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • breaking

      removed the enum value Private of the request property

    • breaking

      removed the enum value Public of the request property

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • info

      added the new Educational enum value to the request property

    • info

      added the new Government Agency enum value to the request property

    • info

      added the new Nonprofit enum value to the request property

    • info

      added the new Partnership enum value to the request property

    • info

      added the new Privately Held enum value to the request property

    • info

      added the new Public Company enum value to the request property

    • info

      added the new Self-Employed enum value to the request property

    • info

      added the new Self-Owned enum value to the request property