Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

GET: Life Cycle Details

Avatar
Ingrid
Follow
  • March 25, 2021: all_activities_completed and activities fields.
  • May 27, 2020: Published.

⇤ Company Life Cycles

https://api.bitsighttech.com/ratings/v1/company-life-cycles

Get Life Cycle stage details of companies in your portfolio.

Parameters

Parameter Description Values 
company_guid
Query		 Filter by company. [Array] Comma-separated company unique identifiers [entity_guid]. See GET: Portfolio Details. 
folder
Query		 Filter by folder. [String] Folder unique identifier [folder_guid]. See GET: Folder Details. 
is_completed
Query		 Filter by companies that have completed a life cycle. [Boolean] true = Include companies that have completed a life cycle. 
life_cycle_type
Query		 Filter by life cycle stage. [Array] Comma-separated life cycle stage slug name. 
tier
Query		 Filter by tier. [String] Tier unique identifiers [tier_guid]. See GET: Tiers.

Example Request

curl 'https://api.bitsighttech.com/ratings/v1/company-life-cycles' -u api_token:

Example Response

{
  "links":{
    "previous":null,
    "next":null
  },
  "count":55,
  "results":[
    […]
    {
      "guid":"55555555-bbbb-5555-bbbb-555555555555",
      "company":{
        "guid":"a5e23bf0-38d4-4cea-aa50-19ee75da481d",
        "name":"Black Hills Technologies"
      },
      "created_time":"2020-02-02T20:20:20Z",
      "creator":"arnold@actorsfilms.us",
      "last_editor":"arnold@actorsfilms.us",
      "days_in_life_cycle":1,
      "display_name":"Re-Assessment",
      "api_name":"re_assessment",
      "completed_time":"2020-03-03T20:20:20Z",
      "is_completed":true
      "all_activities_completed":false,
      "activities":[
        {
          "name":"Review Onboarding Risk Summary",
          "slug":"review_risk_summary",
          "description":"Review with business stakeholders to understand potential risks.",
          "is_completed":false
        }
      ]
    }
  ]
}

Response Attributes

Field Description 
links
Object		 Navigation for multiple pages of results. See pagination.
  
next
String		 The URL to the next page of the results. 
previous
String		 The URL to the previous page of the results. 
count
Integer		 The number of results. 
results
Array		 Life cycle stage details.
  Object A company's life cycle details.
  
guid
String [stage_guid]		 The unique identifier of this stage. 
company
Object		 Company details.
  
guid
String [entity_guid]		 The unique identifier of the company in this stage. 
name
String		 The name of the company in this stage. 
created_time
String [YYYY‑MM‑DDTHH:MM:SSZ]		 The date and time when the company was assigned to this stage. 
creator
String		 The email address of the user who assigned the company to a stage. 
last_editor
String		 The email address of the user who last edited the stage of this company. 
days_in_life_cycle
Integer		 The number of consecutive days the company has been assigned to this stage. 
display_name
String		 The name of this stage. 
api_name
String		 The slug name of this stage. 
completed_time
String [YYYY‑MM‑DDTHH:MM:SSZ]		 The date and time when this stage was marked as completed. 
is_completed
Boolean		 true = This stage is completed. 
all_activities_completed
Boolean		 true = All activities within this stage have been completed by the company. 
activities
Array		 Activity details.
  Object An activity.
  
name
String		 The name of this activity. 
slug
String		 The slug name of this activity. 
description
String		 A description of this activity. 
is_completed
Boolean		 true = This activity has been completed.

Related articles