Loading ...

REST API: Get Unread Notifications | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: Notifications » REST API: Get Unread Notifications
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 26

REST API: Get Unread Notifications

0 
 /5
0 (0votes)
Open API Guide
GET/api/notifications/unread

Enables administrators and developers to programmatically retrieve unread notifications for the current user.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Optional Parameters

ParameterTypeRequiredLocationDescription
NumberOfRecordsIntegerNOQueryNumber of notifications to return per page. Default: 30.
StartPageIntegerNOQueryPage of results to return. Default: 1.
FromDateStringNOQueryStart of the date range. Read in the calling user's time zone (or the site's when the user has none) and converted to UTC. Omit along with ToDate for all unread notifications.
ToDateStringNOQueryEnd of the date range. Read in the calling user's time zone (or the site's when the user has none) and converted to UTC. Omit along with FromDate for all unread notifications.
FromUserIDIntegerNOQueryUserID of the person the notifications are from
EntityTypeIDIntegerNOQueryEntity type ID to limit notifications to; see REST API: System Entity Types.
CategoryIDIntegerNOQueryCategoryID to limit notifications for (only applies to entity types with category)
LastNotificationIDIntegerNOQueryReturns only notifications with an ID greater than this value, useful for incremental fetching

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/notifications/unread?numberOfRecords=5&startPage=1

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ID": 43,
      "SpaceID": 2,
      "SpaceName": "Human Resources",
      "SpaceURL": "https://your-site.com/spaces/2/human-resources",
      "EntityID": 2,
      "ParentEntityID": 0,
      "EntityType": 10,
      "ActivityAction": 60,
      "DateCreated": "2026-01-07T11:42:16.41",
      "DateCreatedString": "13 minutes ago",
      "NewsFeedText": "Laura Carter @mentioned you in: Alexis Fox",
      "IsRead": false,
      "DateRead": "2026-01-07T11:55:24.0509391Z",
      "URL": "https://your-site.com/spaces/2/human-resources/wall/post/2",
      "FromUserID": 5,
      "FromUserInfoDisplayName": "Laura Carter",
      "FromUserAvatarImageURL": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
      "FromUserProfileURL": "https://your-site.com/people/sunny",
      "ActionText": "@mentioned you in",
      "Subject": "Alexis Fox",
      "EntityTypeID": 10,
      "ContentTypeID": 0
    }
  ]
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid.Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages