Sign in

v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Notification

Get a list of notifications.

Get the list of notifications produced by the Black Kite workflow engine.

get/api/v2/notifications

Query parameters

page_numberinteger
Example:1

The number of the page requested.

page_size10 | 20 | 30
Example:10

The number of result items in a single response.

companyIdinteger
Example:347

The id of the company which the notification belongs to.

workflowIdinteger
Example:4819

The id of the workflow which the notification belongs to.

start_datestring date-time
Example:2021-08-09T08:30:30.682Z

The date that the target notifications' date should be newer.

end_datestring date-time
Example:2021-08-09T08:30:30.682Z

The date that the target notifications' date should be older.

statusstring[]

A single or comma separated value of notification status.

Response

Success

NotificationIdinteger required

The unique identifier of this notification.

WorkflowIdinteger nullable

The identifier of the workflow that this notification relates to.

CompanyIdinteger nullable

The identifier of the company that this notification relates to.

Companystring nullable

The name of the company that this notification relates to.

Titlestring

The title of the this notification.

Status'Open' | 'Reviewed' | 'Closed' | 'False Positive' | 'Suppress'

The current status of this notification.

InsertDatestring date-time

Production date of this notification

Detailstring

An informal HTML formatted details of this notification.

NotificationType'findings' | 'tickets' | 'tags' | 'ratings' | 'tags_update' | 'tags_subsidiary' | 'other'

The type of this notification.

Example response

[
  {
    "NotificationId": 45,
    "WorkflowId": 22,
    "CompanyId": 22,
    "Company": "Acme, Inc.",
    "Title": "Workflow: Data Breach",
    "Status": "Open",
    "InsertDate": "2021-08-09T08:30:30.682Z",
    "NotificationType": "findings"
  }
]