Get notifications

Get notifications

get

Query parameters

Typestring · enumOptional

The type of the notification.

Possible values:

Channelstring · enumOptional

The channel of the notification.

Possible values:

TitlestringOptional

The title of the notification.

ContentstringOptional

The content of the notification.

ActionUrlstringOptional

The action url of the notification.

CategorystringOptional

The category of the notification.

TopicstringOptional

The topic of the notification.

TestModebooleanOptional

Flag to indicate if the notification is in test mode.

Statusstring · enumOptional

Contains the enums for the status of notifications.

Possible values:

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/notifications

HTTPcURLJavaScriptPython

GET /api/v1/notifications HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "title": "Title",
        "type": "Segment",
        "channel": "InApp",
        "content": "Content",
        "actionURL": "https://example.com/action",
        "category": "Category",
        "topic": "Topic",
        "sentTime": "2026-01-26T08:03:23.825577+07:00",
        "metadata": null,
        "scheduledDate": null,
        "status": "Sent",
        "testMode": true
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}