Get notes by control ID

List all the notes associated with a given control

🔒 Requires Controls: Get Controls Notes permission

Securitybearer
Request
path Parameters
controlId
required
number
workspaceId
required
number

The Workspace ID associated to the Account

query Parameters
page
number >= 1
Default: 1

Which page of data are you requesting

limit
number [ 1 .. 50 ]
Default: 20

How many items are you requesting

excludeIds
Array of strings

Exclude Notes by IDs

Example:
Responses
200
400

Malformed data and/or validation errors

401

Invalid Authorization

402

You must upgrade your plan to use this feature

403

You are not allowed to perform this action

404

Not Found

412

You must accept the Drata terms and conditions to use the API

500

Internal server error

get/workspaces/{workspaceId}/controls/{controlId}/notes
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "72c9c910-ef35-4a1c-bfdf-9898063ba77b",
      • "comment": "Another note about our Acceptable Use Policy.",
      • "createdAt": "2024-11-18T22:53:51.064Z",
      • "updatedAt": "2024-11-18T22:53:51.064Z",
      • "owner": {}
      },
    • {
      • "id": "7bb294c8-0087-4b8a-ab50-2c003e18cbcb",
      • "comment": "Our <b>Acceptable Use Policy</b> needs to be flushed out.",
      • "createdAt": "2024-11-18T22:52:54.157Z",
      • "updatedAt": "2024-11-18T22:52:54.157Z",
      • "owner": {}
      }
    ],
  • "page": 1,
  • "limit": 10,
  • "total": 100
}