GET: Folder Details

Ingrid

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

This returns each folder as separate objects and shared folders that are owned by you or are associated with you.

Parameters

See query parameters for details on the fields parameter.

Parameter Values

Parameter	Values
exclude_subscription_folders [Query] Determine if subscription folders should be excluded.	[String] `true` = Exclude subscription folders. ↻ `false` = Include subscription folders.

exclude_subscription_folders

[Query] Determine if subscription folders should be excluded.

[String]

true = Exclude subscription folders.
↻ false = Include subscription folders.

Example Request

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

Append a folder unique identifier to the URL for details of a single folder.

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

Example Response

[
  {
    "guid":"ffffffff-4444-4444-ffff-444444444444",
    "name":"My Folder",
    "owner":"jane.doe@example.com",
    "owner_name":"Jane Doe",
    "owner_guid":"bbbbbbbb-4444-4444-bbbb-444444444444",
    "content_expiry_days":null,
    "description":"Companies to monitor.",
    "contains_all_companies":false,
    "order":93760,
    "companies":[
      "33333333-cccc-cccc-3333-cccccccccccc",
      "22222222-dddd-2222-2222-dddddddddddd"
    ],
    "is_selected":false,
    "is_deletable":true,
    "customer_global":false,
    "can_edit_properties":true,
    "shared_options":{
      "is_shared":false,
      "user_can_share":true,
      "shared_with_all_users":false,
      "group_can_edit_contents":false,
      "group_can_edit_properties":false,
      "shared_with":[
        {
          "can_edit_folder_contents":true,
          "email":"john.doe@example.com",
          "can_edit_folder_properties":true
        }
      ],
      "user_can_edit_contents":true
    },
    "subscription_type":null,
    "email_enabled":false,
    "content_subscription_types":[
      "continuous_monitoring"
      "companies_count":2
    ]
  }
]

Response Attributes

Field			Description
guid String [`folder_guid`]			The unique identifier of this folder.
name String			The name of this folder.
owner String			The email address of the owner of this folder. Value: If the API user (you) is a co-owner of this folder, their email will be displayed.
owner_name String			The full name of the owner of this folder. Value: If the API user (you) is a co-owner of this folder, their name will be displayed.
owner_guid String [`user_guid`]			The unique identifier of the owner of this folder. Value: If the API user (you) is a co-owner of this folder, their unique identifier will be displayed.
content_expiry_days Integer			The number of days after which companies in this folder will be removed from it. Default: `null`
description String			A description of this folder.
contains_all_companies Boolean			A static internal value, used to mark the “All Companies” folder.
order Integer			For internal Bitsight use. A static number, used to organize folders in the Bitsight platform.
companies Array [`company_guid`]			Monitored companies in this folder.
is_selected Boolean			For internal Bitsight use. A static internal value, used by the Bitsight platform.
is_deletable Boolean			`true` = The user (you) can delete the folder. Value: This value is `false` if you don't have owner-level permissions or this folder is the “All Companies” folder.
customer_global Boolean			`true` = Identify subscription folders that are generated by the system.
can_edit_properties Boolean			`true` = The user (you) can add companies to this folder. Value: This is determined by the folder owner.
shared_options Object			Details of how this folder is shared. The values of these fields can be changed via the Bitsight API.
	is_shared Boolean		`true` = This folder is shared.
	user_can_share Boolean		`true` = The API user (you) can share this folder.
	shared_with_all_users Boolean		`true` = This folder is shared with all users in the Access Control Group of the API user (you).
	group_can_edit_contents Boolean		If the folder is shared with all users, this value is `true` and indicates all users in the Access Control Group have management permissions, i.e, can add or remove companies.
	group_can_edit_properties Boolean		`true` = This folder is shared with all users of the API user's (you) Access Control Group and all users in the group are owners.
	shared_with Array		Users who have access to this folder.
		can_edit_folder_contents Boolean	`true` = This user has permission to edit folder contents.
		email String	The email address of this user.
		can_edit_folder_properties Boolean	`true` = This user has permission to edit folder properties (owner).
	user_can_edit_contents Boolean		`true` = The API user (you) can add or remove companies.
subscription_type String			Folder types if the type is used for certain subscription types. Value: User-created folders will be `null`.
email_enabled Boolean			`true` = Email alerts are enabled for this folder. This is a separate option from the `alerts_enabled` field, which generates alerts in the Bitsight platform.
content_subscription_types Array			Identifies all subscription types of the companies in this folder.
companies_count Integer			The number of monitored companies in this folder.

December 9, 2022: Added the exclude_subscription_folders parameter.
November 30, 2022: Added the companies_count field.
March 18, 2019: Published.