---
title: "Get a list of notifications."
method: GET
path: "/api/v2/notifications"
tags: ["Notification"]
---

# Get a list of notifications.

`GET /api/v2/notifications`

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

## Query parameters

- `page_number` integer
- `page_size` 10 | 20 | 30
- `companyId` integer
- `workflowId` integer
- `start_date` string, date-time
- `end_date` string, date-time
- `status` string[]

## Response `200`

Success

- Notification[]
  - `NotificationId` integer, required — The unique identifier of this notification.
  - `WorkflowId` integer, nullable — The identifier of the workflow that this notification relates to.
  - `CompanyId` integer, nullable — The identifier of the company that this notification relates to.
  - `Company` string, nullable — The name of the company that this notification relates to.
  - `Title` string — The title of the this notification.
  - `Status` 'Open' | 'Reviewed' | 'Closed' | 'False Positive' | 'Suppress' — The current status of this notification.
  - `InsertDate` string, date-time — Production date of this notification
  - `Detail` string — An informal HTML formatted details of this notification.
  - `NotificationType` 'findings' | 'tickets' | 'tags' | 'ratings' | 'tags_update' | 'tags_subsidiary' | 'other' — The type of this notification.

## Other responses

- `401` — Unauthorized
- `default` — Failure

---

[API](https://skmtc.net/blackkitetech/apis/black-kite-api.md) · [All operations](https://skmtc.net/blackkitetech/apis/black-kite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/blackkitetech/black-kite-api/revisions/7dadaba760fb/schema)