API EndpointsApp NotificationsCount Unread Notifications

Count Unread Notifications

Endpoint

URL: /:projectId/app-notifications/count

Method: GET

Authentication Required: Yes (Access Token in Authorization Header)


Description

This endpoint retrieves the count of unread app notifications for the authenticated user within a specified project.


Request

Path Parameters

ParameterTypeRequiredDescription
projectIdstringYesThe project ID associated with the request.

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token for authentication.

Example Request

GET /12345/app-notifications/count
Content-Type: application/json
Authorization: Bearer <ACCESS_TOKEN>

Response

Success Response (200 OK)

{
  "count": 3
}

Error Responses

Server Error (500 Internal Server Error)

{
  "error": "Server error"
}

Notes

  • This endpoint only counts unread notifications for the authenticated user.
  • Returns a numeric value representing the count of unread notifications.