GET: Collaboration Outbox – Bitsight Knowledge Base

June 16, 2022: Added recipient_customer_access & third_parties fields.
June 23, 2021: Added fields – requester_email, resolved_date, & resolved_by; Added reason & context.risk_vectors.risk_vector.slug parameters.
March 19, 2021: Linked to collaboration status (status) field values.

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

View all requests sent by your organization to collaborate with another company in the Bitsight platform via the Enable Access Program.

Parameters
Example Request
Response Attributes

Parameters

Parameter	Description	Values
company_guid Query	Include requests that are requested for the specified recipient company.	[String] Company unique identifier [`entity_guid`]. See GET: Portfolio Details.
context.risk_vectors.risk_vector.slug Query	Filter by risk vector.	[String] Comma-separated risk vector slug names. Example: ?context.risk_vectors.risk_vector.slug=ssl_configurations%2Cdnssec%2Copen_ports
exclude_requesterid Query	Exclude requests that are sent by the specified user.	[String] User unique identifier [`user_guid`]. See GET: Users.
folder_guid Query	Include requests that are requested for companies in the specified folder.	[String] Folder unique identifier [`folder_guid`]. See GET: Folder Details.
group Query	Filter by the specified user’s Access Control Group.	[String] Comma-separated group unique identifier [`group_guid`]. See GET: Access Control Group.
reason Query	Filter by one or more reasons for collaboration.	[String] Comma-separated collaboration reasons.
requesterid Query	Include requests that are sent by the specified user.	[String] User unique identifier [`user_guid`]. See GET: Users.
status Query	Include collaboration requests that are in the specified state.	[String] Comma-separated collaboration statuses.
tier_guid Query	Include collaboration requests that are requested for companies in the specified tier.	[String] Tier unique identifier [`tier_guid`]. See GET: Tiers.

Example Request

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

Example Response

[
  {
    "guid":"11111111-eeee-1111-eeee-111111111111",
    "ccs":null,
    "requester_guid":"eeeeeeee-8888-eeee-8888-eeeeeeeeeeee",
    "requester_email":"emma@blueseas.com",
    "requestee_first_name":"Maria",
    "requestee_last_name":"Castro",
    "requester_first_name":"Emma",
    "requester_last_name":"Waters",
    "requester_friendly_name":"Emma",
    "requester_formal_name":"Emma Waters",
    "requester_company_guid":"feeccea4-e062-4cf5-9a3d-7034addb12d1",
    "requester_company_name":"Blue Seas International",
    "requester_customer_guid":"c940bb61-33c4-42c9-9231-c8194c305db3",
    "requester_customer_name":"My Company",
    "requestee_friendly_name":"Maria Castro",
    "requestee_formal_name":"Maria Castro",
    "requestee_email":"mcastro@blackhills.com",
    "requestee_phone":" ",
    "requestee_company_guid":"a5e23bf0-38d4-4cea-aa50-19ee75da481d",
    "requestee_company_name":"Black Hills Technologies",
    "requestee_tos_date":null,
    "requestee_last_login":"2021-03-21",
    "message":"Please address these concerns - from Emma",
    "notes":null,
    "created_date":"2021-04-17",
    "created_time":"2021-04-17T12:26:21Z",
    "email_sent_date":"2021-04-24",
    "can_resend_email":true,
    "hubspot_status":"CREATED",
    "status":"Resolved",
    "is_real":true,
    "has_shared_observations":true,
    "has_preferred_contact":false,
    "shared_observations_count":3,
    "invitation_duration":14,
    "trial_duration":45,
    "reason":"informational",
    "context":{
      "date":"2020-03-03",
      "rating":390
    },
    "resolved_by":{
      "guid":"eeeeeeee-8888-eeee-8888-eeeeeeeeeeee",
      "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 [`email`]			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 sender.
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 email can be resent.
hubspot_status String			For internal Bitsight use.
status String			The collaboration status.
is_real Boolean			For internal Bitsight use.
has_shared_observations Boolean			Indicates if 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 Enable Access Program.
shared_observations_count Integer			The number of shared contextual findings.
invitation_duration Integer			The number of days the recipient has to accept the invitation to access the Bitsight platform. This value is set to `14` days.
trial_duration Integer			The number of days the recipient was granted full access to the Bitsight platform.
reason String			The reason why this company was invited to collaborate.
context Object
	date String [`YYYY-MM-DD`]		The date when this rating was generated.
	rating Integer		The rating on this date.
resolved_by String			The user who set collaboration to “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 set by the sender to “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.

Articles in this section

Parameters

Example Request

Example Response

Response Attributes

Related articles