FIREANIME API
Browse API97 operations
POST

GetNotifications

GetNotifications retrieves a paginated list of notifications for the authenticated user.

/api.v1.notification.NotificationService/GetNotifications Bearer required
01

Request

GetNotificationsRequest

GetNotificationsRequestapi.v1.notification.GetNotificationsRequest2 fields

GetNotificationsRequest specifies pagination for the user's notification list.

page
int32

The page number to retrieve (1-based).

limit
int32

The maximum number of items per page.

Request JSON
{
  "page": 1,
  "limit": 20
}
02

Response

GetNotificationsResponse

GetNotificationsResponseapi.v1.notification.GetNotificationsResponse2 fields

GetNotificationsResponse contains a page of the user's notifications.

dataarray
NotificationItem[]

Collection of notification items.

max
int32

The total number of notifications available for the user.

Example response
{
  "data": [
    {
      "id": 1,
      "userId": 1,
      "type": "string value",
      "title": "Frieren: Beyond Journey’s End",
      "body": "Example content",
      "link": "/anime/frieren",
      "image": "https://example.com/image.webp",
      "isRead": true
    }
  ],
  "max": 1
}
03

Referenced models

1 nested message types

NotificationItemapi.v1.notification.NotificationItem10 fields

NotificationItem represents a single alert or message for the user.

id
uint32

Unique database identifier for the notification.

userId
uint32

ID of the user who received the notification.

type
string

High-level category for the notification (e.g., "release", "system", "social").

title
string

Short summary or title of the notification.

body
string

Detailed text content of the notification.

link
string

URL or app path to navigate to when the notification is clicked.

image
string

Optional URL to an image related to the notification (e.g., anime poster).

isRead
bool

Indicates if the notification has been read by the user.

referenceId
string

Optional reference ID to an associated entity (e.g., episode or comment ID).

createdAt
string

Timestamp when the notification was generated (RFC3339 format).

04

Error handling

Common failure codes

unauthenticatedThe Bearer token is missing or invalid.

invalid_argumentThe request payload failed validation.

internalThe service could not complete the operation.