---
title: "Retrieve unread notifications"
method: GET
path: "/notifications/unread"
tags: ["notifications"]
---

# Retrieve unread notifications

`GET /notifications/unread`

## Request

- Base URL: `https://staging.api-golang.boilerplate.hng.tech/api/v1`
- URL: `https://staging.api-golang.boilerplate.hng.tech/api/v1/notifications/unread`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/hngprojects/apis/kimiko-golang-swagger/docs/notifications/unread/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `is_read` boolean, required

## Response `200`

Unread notifications retrieved successfully

- object
  - `status` string
  - `message` string
  - `status_code` integer
  - `data` object
    - `total_notification_count` integer
    - `total_unread_notification_count` integer
    - `notifications` object[]
      - `notification_id` string
      - `is_read` boolean
      - `message` string
      - `created_at` string, date-time

## Other responses

- `400`: Invalid request
- `401`: Unauthorized request

## Changes

- **2024-08-09** `dbbe685d3440`: 1 info
  - endpoint added
- **2024-08-07** `06cecc2ac126`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/hngprojects/apis/kimiko-golang-swagger/changes/notifications/unread/get.md)

---

[API](https://skmtc.dev/hngprojects/apis/kimiko-golang-swagger.md) - [All operations](https://skmtc.dev/hngprojects/apis/kimiko-golang-swagger/llms.txt) - [OpenAPI document](https://skmtc.dev/hngprojects/apis/kimiko-golang-swagger/revisions/2d1d3ed96bb9?raw)