GET /v1/notifications
Get user notifications
Returns paginated list of user notifications with filtering options
Request
GET /v1/notifications
Parameters
[
{
"schema": {
"type": "string",
"default": "1"
},
"required": false,
"name": "page",
"in": "query"
},
{
"schema": {
"type": "string",
"default": "20"
},
"required": false,
"name": "limit",
"in": "query"
},
{
"schema": {
"type": "string"
},
"required": false,
"name": "read",
"in": "query"
},
{
"schema": {
"type": "string"
},
"required": false,
"name": "type",
"in": "query"
}
]
Response
{
"200": {
"description": "Notifications retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"notifications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
},
"read_at": {
"type": [
"string",
"null"
]
},
"metadata": {},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"type",
"title",
"message",
"read_at",
"created_at"
]
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "number"
},
"limit": {
"type": "number"
},
"total": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"has_next": {
"type": "boolean"
},
"has_prev": {
"type": "boolean"
}
},
"required": [
"page",
"limit",
"total",
"total_pages",
"has_next",
"has_prev"
]
},
"summary": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"unread": {
"type": "number"
},
"read": {
"type": "number"
}
},
"required": [
"total",
"unread",
"read"
]
}
},
"required": [
"notifications",
"pagination",
"summary"
]
}
},
"required": [
"success",
"data"
]
}
}
}
}
}
View in Interactive API Reference