Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

GET: Company Requests

Avatar
Ingrid
Follow
Publication Date – July 20, 2020

⇤ Company Requests

https://api.bitsighttech.com/ratings/v2/company-requests

See your existing Company Requests to get a company added to the Bitsight inventory.

Parameters

See query parameters for details on the following parameters:

  • limit (Default: 100)
  • offset
  • q
  • sort

❖ Supports the current alias.

Example: /path/current
Parameter Description Values 
company.guid
Query		 Search completed company requests. [String] Company unique identifier [entity_guid]. See GET: Portfolio Details. 
created_time_gte
Query		 Search requests created on or after the specified datetime. [String ISO 8601 datetime [YYYY-MM-DDTHH:MM:SSZ]. 
created_time_lte
Query		 Search requests created on or before the specified datetime. [String ISO 8601 datetime [YYYY-MM-DDTHH:MM:SSZ]. 
domain
Query		 Filter by domain names. [String Comma-separated domain names. 
exclude_requester.guid❖
Query		 Exclude requesters. [String Comma-separated user unique identifier [user_guid]. See GET: Users. 
requester.guid❖
Query		 Filter by requester. [String Comma-separated user unique identifier [user_guid]. See GET: Users. 
requester.formal_name
Query		 Filter by requester. [String The full name of a user. See GET: Users. 
status
Query		 Filter by company request statuses. [Array] Comma-separated company request statuses. See company request statuses. 
updated_time_gte
Query		 Search requests updated on or after the specified datetime. [Array] ISO 8601 datetime [YYYY-MM-DDTHH:MM:SSZ]. 
updated_time_lte
Query		 Search requests updated on or before the specified datetime. [Array] ISO 8601 datetime [YYYY-MM-DDTHH:MM:SSZ].

Example Request

curl 'https://api.bitsighttech.com/ratings/v2/company-requests' -u api_token:

Example Response

{
  "links":{
    "previous":null,
    "next":"https://api.bitsighttech.com/ratings/v2/company-requests?limit=100&offset=100"
  },
  "count":123,
  "results":[
    {
      "guid":"1a1a1a1a-a1a1-1a1a-a1a1-1a1a1a1a1a1a",
      "domain":"blueseas.com",
      "created_time":"2020-02-02T02:02:02Z",
      "updated_time":"2020-02-05T02:02:02Z",
      "status":"Complete",
      "company":{
        "guid":"feeccea4-e062-4cf5-9a3d-7034addb12d1",
        "name":"Blue Seas International",
        "in_portfolio":false,
        "is_bundle":false,
        "can_view":true,
        "self_published":null
      },
      "requester":{
        "guid":"11111111-aaaa-1111-aaaa-111111111111",
        "formal_name":"Arnold Brown"
      }
    }
  ]
}

Response Attributes

Field Description 
links
Object		 Navigation for multiple pages of company request results. See pagination.
  
previous
String		 The URL to navigate to the previous page of results. 
next
String		 The URL to navigate to the next page of results. 
count
Integer		 The number of your organization’s requests to add companies to the Bitsight inventory. 
results
Array		 Company request details.
  
guid
String [company_request_guid]		 The unique identifier of this company request. 
domain
String		 The requested domain name. 
created_time
String [YYYY‑MM‑DDTHH:MM:SSZ]		 The date and time when this request was submitted. 
updated_time
String [YYYY‑MM‑DDTHH:MM:SSZ]		 The date and time when this request was last edited. 
status
String		 The status of this request. 
company
Object		 If the request status has been completed ("status":"Complete"), this information about the requested company is included.
  
guid
String [entity_guid]		 The unique identifier of the requested company. 
name
String		 The name of the requested company. 
in_portfolio
Boolean		 true = This company is in your portfolio. 
is_bundle
Boolean		 true = This company is part of a rating bundle. 
can_view
Boolean		 For internal Bitsight use. 
self_published
Boolean		 true = This company is self-published. 
requester
Object		 Requester details.
  
guid
String [user_guid]		 The unique identifier of the requester. 
formal_name
String		 The full name of the requester.

Related articles