v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
SupplyChain

Retrieves paginated list of supply chain companies.

Retrieves paginated list of companies from a supply chain search. PivotDomain is optional; when omitted, the customer's corporate domain or the related company of the tenant's domain is used. Only a domain belonging to an actively monitored company can be used as the pivot.

get/api/v2/supplychain/companies

Query parameters

PivotDomainstring

The pivot company domain to analyze supply chain relationships from.

Example:example.com

The pivot company domain to analyze supply chain relationships from. Only domains of actively monitored companies can be used. If omitted, the customer's corporate domain or the related company of the tenant's domain is used.

SearchTokenstring

A key in GUID format, which points to the newly created supply chain search action.

Example:0f8fad5b-d9cb-469f-a165-70867728950e

The search token obtained from searchSupplyChain operation.

page_numberinteger
Example:1

The number of the page requested.

page_size10 | 20 | 30 | 50 | 100 | 250
Example:10

The number of result items in a single response.

Response

Success

CompanyIdinteger nullable

Unique identifier of the company. Null if the company is not monitored.

CompanyNamestring nullable

Name of the company.

Domainstring

Primary domain of the company.

LogoUrlstring nullable

URL to the company logo.

CountryCodestring nullable

Country code (ISO 3166-1 alpha-2).

CountryNamestring nullable

Country name.

Industrystring nullable

Industry/sector of the company.

Relationship'Unmonitored 3rd Party' | '3rd Party' | '4th Party'

Relationship type with the pivot company.

ComplianceRatingnumber double nullable

Compliance rating percentage of the company (0-100). Only available for monitored companies.

DetectionTypesstring[] nullable

List of detection types.

Rsinumber double nullable

Ransomware Susceptibility Index (0-1).

Dbinumber double nullable

Data Breach Index (0-1).

IsMonitoredboolean

Indicates whether the company is currently monitored.

Example response

[
  {
    "CompanyId": 12345,
    "CompanyName": "Example Corp",
    "Domain": "example.com",
    "LogoUrl": "https://logo.clearbit.com/example.com",
    "CountryCode": "US",
    "CountryName": "United States",
    "Industry": "Technology",
    "Relationship": "3rd Party",
    "ComplianceRating": 75.5,
    "DetectionTypes": [
      "Cloud Asset Detected"
    ],
    "CyberGrade": {
      "GradeLetter": "C-",
      "CyberRating": 78.5
    },
    "Rsi": 0.5,
    "Dbi": 0.5,
    "ConcentrationRisk": {
      "Count": 15,
      "Percentage": 25.5,
      "RiskLevel": "Medium"
    },
    "IsMonitored": true,
    "Tags": [
      {
        "TagId": 123,
        "TagName": "Critical Vendor",
        "Color": "#FF5733"
      }
    ]
  }
]