GET: Company Relationship Details

Ingrid

https://api.bitsighttech.com/ratings/v1/company-relationships

Get the company relationship details of your organization.

Parameters

company_guid

[Query] Filter by company.

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

relationship_type

[Query] Filter by relationship type.

Value: [String] Relationship slug name.

Example Request

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

Example Response

{
  […]
  "results":[
    {
      "guid":"bf88b01f-7eb7-4b5b-aa9b-e1f46b5e90d1",
      "company_guid":"331d73bd-11cc-4eca-a92e-87beacec50ff",
      "company_name":"Kati Communications, Inc.",
      "relationship_type":"fourth_party",
      "creator":"jane.doe@saperix.com",
      "last_editor":"jane.doe@saperix.com",
      "created_time":"2020-03-06T18:45:25.021037Z",
      "last_edited_time":"2020-03-06T18:45:25.021082Z"
    }
  ]
}

Response Attributes

Field	Description
guid String [`relationship_guid`]	The unique identifier of the relationship with this company.
company_guid String [`entity_guid`]	The unique identifier of this company.
company_name String	The name of this company.
relationship_type String	The relationship type assigned for this company. See relationship types.
creator String	The login name of the user who initially defined this relationship.
last_editor String	The login name of the user who last modified this relationship.
created_time String	The date and time when this relationship was initially defined.
last_edited_time String	The date and time when this relationship was last modified.

October 23, 2020: Published.