GET: Finding Comments

Ingrid

https://api.bitsighttech.com/ratings/v1/companies/company_guid/findings/rolledup_observation_id/comments

View finding comments, which can be used to track remediation changes.

Parameters

* Required.

expand

[Query] Include additional information.

Values: [string] remediation = Remediation information.

guid

* Required.

[Path] Identify the company to query.

Values:: [string] Company unique identifier [entity_guid]. See GET: Portfolio Details.

rolledup_observation_id

* Required.

[Path] Identify the finding to query.

Values: The rolled up observation ID. See GET: Finding Details.

Example Request

curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/findings/SzL4Z5sQ3aWHdqx_EhEllQ==/comments -u api_token:

Example Response

{
  "links": {
    "next": null,
    "previous": null
  },
  "count": 1,
  "results": [
    {
      "guid": "1efc88fd-29b4-4869-8c89-ccc362f8f630",
      "thread_guid": "681b53fb-edbf-4f31-9726-8fe14ed8a12e",
      "created_time": "2025-03-18T15:50:52.241772Z",
      "last_update_time": "2025-03-18T15:50:52.241798Z",
      "message": "example comment",
      "is_public": false,
      "is_deleted": false,
      "parent_guid": null,
      "author": {
        "guid": "bd003dbc-1234-4b83-a4d8-4c417120a79c",
        "name": "User Name"
      },
      "company": {
        "guid": "a940bb61-33c4-42c9-9231-c8194c305db3",
        "name": "Company Name"
      },
      "tagged_users": [],
      "remediation": {
        "current": {
          "status": "Work In Progress",
          "assignments": [
            {
              "guid": "bd003dbc-1234-4b83-a4d8-4c417120a79c",
              "name": "User Name"
            }
          ]
        },
        "previous": {
          "status": "Open",
          "assignments": []
        }
      }
    }
  ]
}

Response Attributes

Field							Description
links Object							Navigation for multiple pages of results. See pagination.
	next String						The URL to navigate to the next page of results.
	previous String						The URL to navigate to the previous page of results.
count Integer							The number of comments.
results Array							Comments and their details.
	Object						A comment and its details.
		guid String [`comment_guid`]					The comment’s unique identifier.
		thread_guid String [`thread_guid`]					The comment thread’s unique identifier.
		created_time String [`YYYY‑MM‑DDTHH:MM:SSZ`]					The date and time when the comment was created.
		last_update_time String [`YYYY‑MM‑DDTHH:MM:SSZ`]					The date and time when the comment was last updated.
		message String					The comment’s message.
		is_public Boolean					`true` = The comment is public.
		is_deleted Boolean					`true` = The comment is deleted.
		parent_guid String [`comment_guid`]					The unique identifier of the first comment in the thread.
		author Object					The comment author's information.
			guid String [`user_guid`]				The comment author's unique identifier.
			name String				The comment’s author's name.
		company Object					The company where the comment was created.
			guid String [`entity_guid`]				The company’s unique identifier.
			name String				The company name.
		tagged_users Array					Users tagged in the comment.
			Object				A user and their details.
				guid String [`user_guid`]			The tagged user’s unique identifier.
				name String			The tagged user’s name.
		remediation Object					The comment’s remediation information. Requires the `expand=remediation` parameter.
			current Object				The comment’s current remediation information.
				status String			The comment’s current remediation status.
				assignments Array			Users who are currently assigned to remediate this finding and their details.
					Object		A user and their details.
						guid String [`user_guid`]	The assigned user’s unique identifier.
						name String	The assigned user’s name.
			previous Object				The comment’s previous remediation information.
				status String			The comment’s previous remediation status.
				assignments Array			The comment’s previous remediation assignments.
					Object		An assignment and its details.
						guid String [`assignment_guid`]	The assignment’s unique identifier.
						name String	The assignment name.

April 7, 2025: Published.