GET: Company Search

Ingrid

⇤ Companies

https://api.bitsighttech.com/ratings/v1/companies/search

Search for a company in the Bitsight inventory by name or domain.

Parameters

❖ Either the domain or name parameter is required.

See query parameters for details on the following parameters:

limit (Default: ↻ 100)
offset

Parameter Values

Parameter	Values
`domain` ❖ [Query] Search by domain name.	[String] The domain of a company. Example: `saperix.com`
`expand` [Query] Include additional company information. Using this parameter could slow the performance of the endpoint and limit results to 10 companies.	[String] `details` = Return additional company information.
`guids` [Query] Search by company unique identifier. This disables the `name` and `domain` parameters.	[String] Company unique identifier [`entity_guid`]. See GET: Portfolio Details.
`industry` [Query] Filter by industry.	[String] Industry name. Use GET: Industries with the `show_all` parameter set to `true` [`/v1/industries?show_all=true`].
`industry_slug` [Query] Filter by industry.	[String] Industry slug name. Use GET: Industries with the `show_all` parameter set to `true` [`/v1/industries?show_all=true`].
`in_portfolio` [Query] Filter by portfolio companies.	[Boolean] `true` = Limit results to only portfolio companies.
`name` ❖ [Query] Search by company name.	[String] The name of a company. Example: `Saperix, Inc.`
`scope` [Query] Filter by Security Posture Management and Benchmarking companies.	[String] `spm`

domain

❖ [Query] Search by domain name.

[String] The domain of a company.

Example: saperix.com

expand

[Query] Include additional company information.

Using this parameter could slow the performance of the endpoint and limit results to 10 companies.

[String] details = Return additional company information.

guids

[Query] Search by company unique identifier.

This disables the name and domain parameters.

[String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

industry

[Query] Filter by industry.

[String] Industry name. Use GET: Industries with the show_all parameter set to true [/v1/industries?show_all=true].

industry_slug

[Query] Filter by industry.

[String] Industry slug name. Use GET: Industries with the show_all parameter set to true [/v1/industries?show_all=true].

in_portfolio

[Query] Filter by portfolio companies.

[Boolean] true = Limit results to only portfolio companies.

name

❖ [Query] Search by company name.

[String] The name of a company.

Example: Saperix, Inc.

scope

[Query] Filter by Security Posture Management and Benchmarking companies.

[String] spm

Example Request

curl -u 'api_token:' 'https://api.bitsighttech.com/ratings/v1/companies/search?domain=saperix.com&expand=details'

Example Response

{
  "links":{
    "next":null,
    "previous":null
  },
  "count":10,
  "results":[
    […]
    {
      "guid":"819b6a11-d1c6-4518-9566-0611c34d5d8e",
      "name":"Saperix Hosting Service",
      "industry":"Technology",
      "industry_slug":"technology",
      "primary_domain":"saperix.com",
      "description":"Saperix Technologies LLC develops risk analysis software solutions.",
      "website":"http://saperix.com/hosting",
      "details":{
        "is_bundled":false,
        "is_primary":false,
        "is_service_provider":false,
        "has_company_tree":true,
        "search_history_count":5143,
        "customer_monitoring_count":84,
        "self_published":"public",
        "confidence":"High",
        "logo":"https://api.bitsighttech.com/ratings/v1/companies/819b6a11-d1c6-4518-9566-0611c34d5d8e/logo-image",
        "in_portfolio":true,
        "search_token":"540H3GPGtrT-_T2WZ3m8vkn5TEzXumFwQCoYZGhLunUCCWo77BHf19Ik9XeWh0TbONQAI-9uJaVC7fdQee_vlRK28r_RDQM0MuSNHpHbUpV3btbfS3vkReJ7jirHGKud3t3J1CfxBMiyUp_N21Fv0Xh03itXMWXOQkCNjlvXFqghJbeXgIv5xgFhm8Ght2nn",
        "primary_company":null
      }
    }
  ]
}

Response Attributes

Field				Description
`links` Object				Navigation for multiple pages of results. See pagination.
	`next` String			The URL for navigating to the next page of results.
	`previous` String			The URL for navigating to the previous page of results.
`count` Integer				The amount of search results.
`results` Array				Company search results.
	Object			A company in the search results.
		`guid` String [`entity_guid`]		The unique identifier of this company.
		`name` String		The name of this company.
		`industry` String		This company’s industry.
		`industry_slug` String		The slug name of this company’s industry.
		`primary_domain` String		The main domain that belongs to this company.
		`description` String		A description of this company and its purpose.
		`website` String		The web address (URL) to this company’s primary domain.
		`details` Object		If the `expand` parameter is set to `details` (`&expand=details`), these company details are included.
			`is_bundled` Boolean	`true` = This company is part of a ratings bundle.
			`is_primary` Boolean	`true` = This company is designated as the primary, which the publisher believes better reflects their security posture.
			`is_service_provider` Boolean	`true` = This company is a service provider.
			`has_company_tree` Boolean	`true` = This company has a Ratings Tree.
			`search_history_count` Integer	The number of times this company has appeared in searches.
			`customer_monitoring_count` Integer	The number of companies that are currently monitoring this company.
			`self_published` String	Indicates if this self-published report is `public` or `private`.
			`confidence` String	The level of confidence in the quality of the company data. `High` = The data is accurate. `Low` = The data is limited.
			`logo` String	The URL path of this company’s logo image in the Bitsight platform.
			`in_portfolio` Boolean	`true` = This company is in your portfolio.
			`search_token` String	An auto-generated unique identifier for this search.
			`primary_company` String	The name of the primary designated for this company’s organization.

December 5, 2023: How to get the industry name.
October 24, 2022: Added guids, industry, industry_slug, in_portfolio, & scope parameters.
July 8, 2021: Updated expand parameter; Added details field to examples.