GET: Collaboration Invitation Details – Bitsight Knowledge Base

https://api.bitsighttech.com/ratings/v1/access-requests/received/collab_guid

See details of a particular received invitation to collaborate via the Client/Vendor Access Program.

Parameters

* Required.

guid

* Required.

[Path] Identify the invitation to query.

Value: [String] Collaboration invitation unique identifier [collab_guid]. See GET: Collaboration Inbox.

Example Request

curl https://api.bitsighttech.com/ratings/v1/access-requests/received/11111111-eeee-1111-eeee-111111111111 -u api_token:

Example Response

{
  "guid":"11111111-eeee-1111-eeee-111111111111",
  "ccs":null,
  "requester_guid":"11111111-aaaa-1111-aaaa-111111111111",
  "requester_email":"emma@blueseas.com",
  "requestee_first_name":"Emma",
  "requestee_last_name":"Waters",
  "requester_first_name":"Arnold",
  "requester_last_name":"Brown",
  "requester_friendly_name":"Arnold",
  "requester_formal_name":"Arnold Brown",
  "requester_company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
  "requester_company_name":"Actors Films",
  "requester_customer_guid":"cccccccc-4444-cccc-4444-cccccccccccc",
  "requester_customer_name":"Actors Films",
  "requestee_friendly_name":"Emma",
  "requestee_formal_name":"Emma Waters",
  "requestee_email":"emma@blueseas.com",
  "requestee_phone":" ",
  "requestee_company_guid":"feeccea4-e062-4cf5-9a3d-7034addb12d1",
  "requestee_company_name":"Blue Seas International",
  "requestee_tos_date":null,
  "requestee_last_login":"2021-06-08",
  "message":"Welcome! We use Bitsight Security Ratings to monitor our third parties.",
  "notes":null,
  "created_date":"2021-03-29",
  "created_time":"2021-03-29T21:39:03Z",
  "email_sent_date":"2021-03-29",
  "can_resend_email":true,
  "hubspot_status":"EXISTING",
  "status":"Resolved",
  "is_real":true,
  "has_shared_observations":false,
  "has_preferred_contact":false,
  "shared_observations_count":0,
  "read":true,
  "reason":"remediation",
  "context":{
    "date":"2021-06-06",
    "rating":790,
    "risk_vectors":[
      {
        "grade":"A",
        "percentile":91.86271,
        "risk_vector":{
          "name":"Open Ports",
          "slug":"open_ports"
        }
      }
    ]
  },
  "resolved_by":{
    "guid":"11111111-aaaa-1111-aaaa-111111111111",
    "formal_name":"Emma Waters"
  },
  "resolved_date":"2021-06-21",
  "recipient_customer_access":"inactive",
  "third_parties":[
    {
      "name":"Richard Kuga",
      "email":"richard.kuga@saperix.com"
    }
  ]
}

Response Attributes

Field					Description
guid String [`collab_guid`]					The unique identifier of the collaboration request.
ccs String					An email address that’s carbon copied (CC) on the invitation email.
requester_guid String [`user_guid`]					The unique identifier of the sender.
requester_email String					The email of the sender.
requestee_first_name String					The given name of the recipient.
requestee_last_name String					The surname of the recipient.
requester_first_name String					The given name of the sender.
requester_last_name String					The surname of the sender.
requester_friendly_name String					The preferred name of the sender.
requester_formal_name String					The full name of the sender.
requester_company_guid String [`entity_guid`]					The unique identifier of the sender’s company.
requester_company_name String					The name of the sender’s company.
requester_customer_guid String [`account_guid`]					The unique identifier of the sender’s account.
requester_customer_name String					The name of the sender’s account.
requestee_friendly_name String					The preferred name of the recipient.
requestee_formal_name String					The full name of the recipient.
requestee_email String					The email address of the recipient.
requestee_phone String					The phone number of the recipient.
requestee_company_guid String [`entity_guid`]					The unique identifier of the recipient company.
requestee_company_name String					The name of the recipient company.
requestee_tos_date String [`YYYY‑MM‑DD`]					The date when the recipient accepted the Bitsight Terms and Conditions and activated their account. This value is null if the recipient hasn’t activated their Bitsight account.
requestee_last_login String [`YYYY‑MM‑DD`]					The most recent date when the recipient logged in to the Bitsight platform.
message String					The message from the sender to the recipient.
notes String					Private notes from the sender for other users in their organization. This is not visible to recipients.
created_date String [`YYYY‑MM‑DD`]					The date when the collaboration request was submitted.
created_time String [`YYYY‑MM‑DDTHH:MM:SSZ`]					The date and timestamp when the request was submitted.
email_sent_date String [`YYYY‑MM‑DD`]					The date when the invitation email was sent.
can_resend_email Boolean					`true` = The invitation email can be resent to the recipient.
hubspot_status String					For internal Bitsight use.
status String					The collaboration status.
is_real Boolean					For internal Bitsight use.
has_shared_observations Boolean					`true` = This request included contextual findings.
has_preferred_contact Boolean					`true` = This company has assigned a user as their preferred contact for receiving invitations to collaborate via the Client/Vendor Access Program.
shared_observations_count Integer					The number of shared contextual findings.
read Boolean					`true` = This invitation to collaborate has been received and read.
reason String					The reason why your organization was invited to collaborate.
context Object					Context provided by the sender for collaboration.
	date String [`YYYY‑MM‑DD`]				The date pertaining to the provided context.
	rating Integer				The rating on this date provided as context.
	risk_vectors Array				Risk vectors provided as context.
		Object			The details of a risk vector provided as context.
			grade String		The letter grade of this risk vector.
			percentile Decimal
			risk_vector Object		Details of this risk vector.
				name String	The name of this risk vector.
				slug String	The slug name of this risk vector.
resolved_by Object					The sender who marked collaboration as “resolved.”
	guid String [`user_guid`]				The unique identifier of this user.
	formal_name String				The full name of this user.
resolved_date String [`YYYY‑MM‑DD`]					The date when collaboration was marked as “resolved.”
recipient_customer_access String					The activation status of the recipient.
third_parties Array					Additional recipients that have been added to the Assign CCs field.
	Object				A contact.
		name String			This contact’s name.
		email String			This contact’s email address.

June 16, 2022: Added recipient_customer_access & third_parties fields.
June 21, 2021: Added requester_email, resolved_by, & resolved_date fields; Added examples of context details (date, rating & risk_vectors).
March 19, 2021: Published.

Parameters

Example Request

Example Response

Response Attributes

Related articles