Skip to content
Capturit Backend Docs

Retrieve Notifications

GET api/notification/list

This is used to retrieve notifications.

Example Request

Terminal window
curl -X 'GET' \
  'http://localhost:8080/api/notification/list?page=<page>&page_length=<page_length>' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Parameters

page

Type: Query
Data Type: Integer
Required: Yes
Description: The current page number in the pagination

page_length

Type: Query
Data Type: Integer
Required: Yes
Description: The number of items displayed per page in the pagination

Responses

200 - OK

The request was successful

Content Type: application/json
Content: Notifications

{
  "current_page": 0,
  "data": [
    {
        "id": 0,
        "notification_title": "string",
        "notification_type": 0,
        "notification_item_id": 0,
        "notification_mark_as_read": true,
        "notification_data": {
            "user_avatar": "string",
            "notification_message": {
                "id": 0,
                "value": "string",
                "type": 0
            },
            {
                "id": 0,
                "value": "string",
                "type": 0
            }
        }
    }
  ],
  "first_page_url": "string",
  "from": 0,
  "next_page_url": "string",
  "path": "string",
  "per_page": "string",
  "prev_page_url": "string",
  "to": 0
}

401 - Unauthorized

The request requires valid bearer token, but none were provided, or the bearer token is invalid.

429 - Too Many Requests

The user has exceeded the rate limit of 120 requests per minute.

500 - Internal Server Error

There is an issue with the backend. Sentry will provide a more detailed report on the problem.