REST API Documentation
/core/members/{id}/notifications
Get list of notifications for a member
Parameters
Name | Type | Description |
---|---|---|
page
|
int | Page number |
perPage
|
int | Number of results per page - defaults to 25 |
Exceptions
Code | Message | Description |
---|---|---|
2C292/K |
NO_PERMISSION |
The authorized user does not have permission to view the follows |
2C292/L |
INVALID_ID |
The member could not be found |
Response
Name | Type | Description |
---|---|---|
page
|
int | The page number for the results being shown |
perPage
|
int | The number of results that will be on each page |
totalResults
|
int | The total number of results |
totalPages
|
int | The number of pages of results |
results
|
array of inline objects | The results for this page |
inline
object
Name | Type | Description |
---|---|---|
notificationType
|
string | The type (key) of notification sent |
notificationApp
|
string | The app that processes this type of notification |
itemClass
|
string | The class that triggered the notification |
itemId
|
int | The ID of the content that triggered the notification |
subItemClass
|
string | The sub-class that triggered the notification (e.g. for comments or reviews) |
subItemId
|
int | The sub-ID of the content that triggered the notification (e.g. for comments or reviews) |
item
|
object|null | A representation of the item being notified about (if supported), or null |
itemSub
|
object|null | A representation of the subitem being notified about (if supported), or null |
sentDate
|
datetime | Date and time the notification was sent |
updatedDate
|
datetime | Date and time the notification was last updated |
readDate
|
datetime|null | Date and time the notification was read by the user |
notificationData
|
array | Array of additional data relevant to this specific notification |