Get Notes

GET {{cb_url}}/api/alerts/v7/orgs/{{cb_org_key}}/alerts/{{cb_alert_id}}/notes?sort_field=create_timestamp&sort_order=desc

Get all notes associated with an Alert.

RBAC Permissions Required

Permission (.notation name)Operation(s)
org.alerts.notesREAD

See complete documentation on the Developer Network -Alerts API

Request Params

KeyDatatypeRequiredDescription
sort_fieldstringSpecify the field that will be used to sort notes.
sort_orderstringSpecify the sort order, ASC or DESC

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"results":[{"author":"demouser@demoorg.com","create_timestamp":"2023-04-16T23:35:10.295Z","last_update_timestamp":"2023-04-16T23:35:10.295Z","id":"eb0c0791-505b-408e-8b03-24562a95a875","source":"CUSTOMER","note":"A note for API demo"}],"num_found":1,"num_available":1}