Loading ...

REST API: Get Notifications | Axero Documentation

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

REST API: Get Notifications

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

Retrieves a paginated list of notifications for the authenticated user. Results can be filtered by date range, sender, entity type, category, and read status.

Request

Request Header

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

Optional Parameters

ParameterTypeRequiredLocationDescription
StartPageIntegerNOQueryPage of results to return (1-based). Default: 1.
PageLengthIntegerNOQueryNumber of notifications to return per page. Default: 10.
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 to return all 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 to return all notifications.
FromUserIDIntegerNOQueryUser ID of the sender to filter notifications by
EntityTypeIDIntegerNOQueryEntity type ID to filter notifications by; see REST API: System Entity Types.
CategoryIDIntegerNOQueryCategory ID to filter notifications by. Only applies to entity types that support categories
IsReadBooleanNOQueryFilter by read status. When true, returns only read notifications. When false, returns only unread notifications. Omit to return all

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/notifications?StartPage=1&PageLength=2

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ID": 3,
      "SpaceID": 2,
      "SpaceName": "Human Resources",
      "SpaceURL": "https://your-site.com/spaces/2/human-resources",
      "EntityID": 2,
      "ParentEntityID": 0,
      "EntityType": 10,
      "ActivityAction": 60,
      "DateCreated": "2026-02-15T04:26:19.153",
      "DateCreatedString": "59 seconds ago",
      "NewsFeedText": "Alexis Fox @mentioned you in: Laura Carter You should join this space",
      "IsRead": false,
      "DateRead": "2026-02-15T04:27:18.7004558Z",
      "URL": "https://your-site.com/spaces/2/human-resources/wall/post/2",
      "FromUserID": 5,
      "FromUserInfoDisplayName": "Alexis Fox",
      "FromUserAvatarImageURL": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
      "FromUserProfileURL": "https://your-site.com/people/alexis",
      "ActionText": "@mentioned you in",
      "Subject": "Laura Carter You should join this space",
      "EntityTypeID": 10,
      "ContentTypeID": 0
    },
    {
      "ID": 2,
      "SpaceID": 2,
      "SpaceName": "Human Resources",
      "SpaceURL": "https://your-site.com/spaces/2/human-resources",
      "EntityID": 1,
      "ParentEntityID": 0,
      "EntityType": 15,
      "ActivityAction": 15,
      "DateCreated": "2026-02-15T04:25:46.403",
      "DateCreatedString": "a minute ago",
      "NewsFeedText": "Alexis Fox invited you to a space: Human Resources",
      "IsRead": false,
      "DateRead": "2026-02-15T04:27:18.7004558Z",
      "URL": "https://your-site.com/spaces/2/human-resources",
      "FromUserID": 5,
      "FromUserInfoDisplayName": "Alexis Fox",
      "FromUserAvatarImageURL": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
      "FromUserProfileURL": "https://your-site.com/people/alexis",
      "ActionText": "invited you to a space",
      "Subject": "Human Resources",
      "EntityTypeID": 15,
      "ContentTypeID": 0
    }
  ]
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestInvalid query parameter value or unsupported filter combination.Verify that all query parameter values are valid and properly formatted.
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