Notifications

Get Notifications

GET https://{organisation}.clearlrs.com/api/notifications

This endpoint allows you to get notifications given certain conditions.

Query Parameters

Name	Type	Description
limit	number	Restricts the number of results returned
skip	number	Skips over this number of items in the search results
activity:attribute:{attributeName}	string	Filters notifications to only include activities with the specified value for the attribute {attributeName}
activity:tags	string	A comma separated string of tags. Filters notifications to only include those belonging to activities that have all specified tags.
channel	string	The notification channel
query	string	Regular expression to filter recipients of notifications. Retrieves notifications that are received by actors that match the provided regular expression.
since	string	A JSON date object. Only get notifications with a timestamp greater than this date.
actorId	string	Only retrieves notifications that the actor with this actor id has received
activityId	string	Only retrieves notifications pertaining to the activity with this activity id
activityId!	string	Retrieves notifications for all activities excluding the activity whose activity id is provided here

200

[
    {
        "activity": {
            "definition": {
                "name": {
                  "en": "Activity 1"
                 },
                "extensions": {},
                "type": "http://adlnet.gov/expapi/activities/module"
            }
            "id": "ActivityId",
            "objectType": "Activity"
        },
        "actor": {
            "account": {
                "homePage": "https://organisation.clearlrs.com"
                "name": "uuid"
            }
            "name": "John Smith"
            "objectType": "Agent"
        },
        "channel": "hub",
        "object": {}
        "tiimestamp": "2020-07-29T04:48:09.039Z"
    }
]