# Notifications

## Get Notifications

<mark style="color:blue;">`GET`</mark> `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                                                      |

{% tabs %}
{% tab title="200 " %}

```javascript
[
    {
        "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"
    }
]
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://dev.clearxp.com/clear-api-reference/notifications.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.