Skip to main content
GET
/
v1
/
notifications
/
count
Get notification status counts
curl --request GET \
  --url https://staging.api.us.aptlydone.com/v1/notifications/count \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2026-01-12T09:08:08.140Z",
  "message": "Success",
  "data": {
    "unread": 5,
    "read": 10,
    "total": 15,
    "timePeriod": "1m"
  }
}

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ā€‹
tenantId
string<uuid>

Tenant ID to filter notifications (optional, defaults to user active tenant)

Example:

"123e4567-e89b-12d3-a456-426614174000"

ā€‹
timePeriod
enum<string>

Filter by time period (1m, 3m, 6m, all)

Available options:
1m,
3m,
6m,
all

Response

200 - application/json

Notification counts retrieved successfully

ā€‹
statusCode
number
required

HTTP Status code

Example:

200

ā€‹
timestamp
string
required

Timestamp of the response

Example:

"2026-01-12T09:08:08.140Z"

ā€‹
message
string
required

Response message

Example:

"Success"

ā€‹
data
object
required

Response data