---
title: "Get a list of monitored companies."
method: GET
path: "/api/v2/companies"
tags: ["Company"]
---

# Get a list of monitored companies.

`GET /api/v2/companies`

Get the list of companies, in other words, the requesting customer's portfolio. Products will be available when a search is being executed using the ProductGroupIds field in the companies/search endpoint.

## Query parameters

- `page_number` integer
- `page_size` 10 | 20 | 30 | 50 | 100 | 250
- `key` string — A key in GUID format, which points to the search criteria used in searchCompanies operation.

## Response `200`

Success

- Company[]
  - `CompanyId` integer, required — The ID of the company in BlackKite.
  - `CompanyName` string — The name of the company in BlackKite.
  - `DomainName` string — The main domain value of the company.
  - `Type` 'normal' | 'group' — There are two types of companies; normal and group. Group companies are formed by grouping normal or group companies.
  - `CyberRating` CyberRating
    - `GradeLetter` 'A+' | 'A' | 'A-' | 'B+' | 'B' | 'B-' | 'C+' | 'C' | 'C-' | 'D+' | 'D' | 'D-' | 'F', nullable — Overall technical risk score translated into GPA letter grades.
    - `CyberRating` number, nullable — Overall technical risk score.
    - `BreachIndex` number, float, nullable — The Data Breach Index (DBI) is a key performance index that tracks data breaches, measuring their severity based on the number of records compromised and when the data was breached.
    - `RansomwareIndex` number, float, nullable — Ransomware Susceptibility Index (RSI) is a metric for customers to understand which of their companies are susceptible to a ransomware attack.
    - `CyberRatingLastUpdatedAt` string, date-time, nullable — The recent date the CyberRating score is calculated.
    - `RansomwareIndexLastUpdatedAt` string, date-time, nullable — The recent date the RansomwareIndex score is calculated.
    - `BreachIndexLastUpdatedAt` string, date-time, nullable — The recent date the BreachIndex score is calculated.
  - `ThreatActor` ThreatActor, nullable
    - `OverallAsiScore` number — Overall susceptibility score based on matched adversaries and threat actor tactics.
    - `ThreatActorResults` ThreatActorResult[], nullable — An array of threat actors affected the company.
      - `ThreatActorName` string — The name of the threat actor group.
      - `AsiScore` number — The Adversary Susceptibility Index (ASI) of the company.
      - `Reasoning` string — The explanation for why this threat actor may target the company.
  - `Compliance` ComplianceRating
    - `Rating` number, nullable — Overall compliance risk score.
    - `Confidence` number, nullable — Overall compliance confidence score.
    - `Completeness` number, nullable — Overall compliance coverage/completeness score.
    - `LastUpdatedAt` string, date-time, nullable — The recent date the ComplianceRating score is calculated.
  - `FinancialImpact` FinancialImpact
    - `Rating` number, float, nullable — Overall financial (the annualized risk exposure) risk score.
    - `RatingMin` number, float, nullable — Overall minimum financial (the annualized minimum risk exposure) risk score.
    - `RatingMax` number, float, nullable — Overall maximum financial (the annualized maximum risk exposure) risk score.
    - `LossMagnitude` number, float, nullable — How much loss is our organization likely to experience as a direct result of a loss event.
    - `LossEventFrequency` number, float, nullable — The percentage that over the next year is the loss event likely to occur.
    - `LastUpdatedAt` string, date-time, nullable — The recent date the FinancialImpactRating (FAIR) score is calculated.
  - `FinancialImpacts` FinancialImpacts[], nullable — An array of FinancialImpactRating (FAIR) score of this company. The difference between the FinancialImpact and FinancialImpacts fields is that, in addition to the default Breach model, FinancialImpacts field also contains two more new models; Ransomware and Business Interruption.
    - `Rating` number, float, nullable — Overall financial (the annualized risk exposure) risk score.
    - `RatingMin` number, float, nullable — Overall minimum financial (the annualized minimum risk exposure) risk score.
    - `RatingMax` number, float, nullable — Overall maximum financial (the annualized maximum risk exposure) risk score.
    - `LossMagnitude` number, float, nullable — How much loss is our organization likely to experience as a direct result of a loss event.
    - `LossEventFrequency` number, float, nullable — The percentage that over the next year is the loss event likely to occur.
    - `LastUpdatedAt` string, date-time, nullable — The recent date the FinancialImpactRating (FAIR) score is calculated.
    - `RiskType` 'Data Breach' | 'Ransomware' | 'Business Interruption', string, nullable — The type of Financial Risk. It can be Data Breach, Ransomware or Business Interruption.
  - `DashboardLink` string — The BlackKite portal dashboard link for the specified company.
  - `Ecosystems` EcosystemOfCompany[], nullable — An array of Ecosystems that this company is defined under.
    - `EcosystemId` integer, required — The unique id of the ecosystem.
    - `EcosystemName` string — The name of the ecosystem.
  - `Licenses` CompanyLicense[], nullable — An array of Licenses that this company is defined under.
    - `LicenseType` 'Continuous 60-day' | 'Continuous Annual' | 'Not Attached' — The type of the license.
    - `LicenseStatus` 'Active' | 'Inactive' — The status of the license.
  - `Industry` Industry, nullable
    - `IndustryId` integer — The unique identifier of this industry.
    - `IndustryName` string — The name of the industry.
  - `Country` string, nullable — The full country name of the company.
  - `Tags` TagOfCompany[], nullable — An array of Tags attached to this company.
    - `TagId` integer, required
    - `TagName` string
    - `TagType` 'Custom Tag' | 'Focus Tag' | 'System Tag' — Black Kite provides a tagging ability for labelling companies. There are two types of tags; Custom and Focus tags. Custom tags are the labels that are assigned to the companies by the clients. On the other hand, FocusTags are the labels assigned directly to the companies by the Black Kite system.
  - `Products` Product[], nullable — The list of products (containing CPEs) will only be populated when a company search is done using a product group.
    - `Asset` string, required — The value of the asset that has the product. May contain IP address or domain name.
    - `Cpe` string, required — A CPE reference.
    - `Port` number — The port number of the service.
    - `Protocol` string — The application protocol name that the service uses.
  - `ScanStatus` 'Extended Scan Queued' | 'Extended Scan Running' | 'Extended Scan Failed' | 'Extended Results Ready' | 'Extended Rescan Queued' | 'Extended Rescan Running' | 'Extended Rescan Failed' | 'Extended Rescan Results Ready' | 'Unknown Scan Status' — The ones with "Extended Scan" prefix mean, this is the first time Black Kite executes a comprehensive scan on the related company. This is the phase where extensive technical issues will be extracted. The ones with "Extended Rescan" prefix mean, this is one of the many continuous scans that Black Kite executes against the target company. In summary, when the status value contains both the words "Extended" and "Ready", that means the results are ready for processing. Beware that this property is only related to the technical rating part of the three dimensional Black Kite rating system. So, the value of ScanStatus property doesn’t tell you whether the Compliance or FinancialImpact property values are calculated yet or not.

## Other responses

- `401` — Unauthorized
- `404` — Not Found
- `default` — Failure

---

[API](https://skmtc.net/blackkitetech/apis/black-kite-api.md) · [All operations](https://skmtc.net/blackkitetech/apis/black-kite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/blackkitetech/black-kite-api/versions/7dadaba760fb/schema)