GET: My Subsidiaries

Ingrid

https://api.bitsighttech.com/ratings/v1/subsidiaries

See your subsidiaries.

Parameters

company_guid

[Query] Identify your organization.

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

↻ Default = My Company

include_subscription_type

[Query] Filter by subscription type.

Value: [String] my_subsidiary

Example Request

curl https://api.bitsighttech.com/ratings/v1/subsidiaries -u api_token:

Example Response

{
  "requested_company":{
    "guid":"a940bb61-33c4-42c9-9231-c8194c305db3",
    "name":"Saperix, Inc.",
    "subscription_type_key":"continuous_monitoring"
  },
  "subsidiaries":[
    […]
    {
      "guid":"819b6a11-d1c6-4518-9566-0611c34d5d8e",
      "name":"Saperix Hosting Service",
      "subscription_type_key":"my_subsidiary"
    }
  ]
}

Response Attributes

Field			Description
requested_company Object			The requested company; Your My Company.
	guid String [`entity_guid`]		Your My Company’s unique identifier.
	name String		Your My Company’s name.
	subscription_type_key String		The subscription slug name used for your My Company.
subsidiaries Array			Subsidiaries in your organization.
	Object		A subsidiary.
		guid String [`entity_guid`]	This subsidiary’s unique identifier.
		name String	This subsidiary’s name.
		subscription_type_key String	The subscription slug name used for this subsidiary.

Status Codes

See the common errors and status codes.

200 – Okay: Everything worked as expected.
400 – Bad Data: This can often be due to missing a required parameter.
401 – No Authentication: No valid API token was provided.
403 – Unauthorized: You do not have permission to access this resource.
404 – Not Found: The specified resource could not be found or does not exist.

June 23, 2022: Published.