Skip to main content

Alerts

Retrieve in‑app alert notifications for the current authenticated user.

API endpoint​

GET {accessURL}/{organizationName}/notificationservice_/notificationserviceapi/odata/v1/Alerts

Replace {accessURL} in all endpoint paths with the base URL for your cloud platform:

Cloud platformAccess URL
Test Cloudhttps://cloud.uipath.com/
Test Cloud Public Sectorhttps://govcloud.uipath.us/
Test Cloud Dedicatedhttps://{customURL}.dedicated.uipath.com/

Request headers​

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Query parameters​

The endpoint supports standard OData query options on the Alerts collection:

  1. $filter: Filter alerts.

    Example: ?$filter=Severity eq 'High'

  2. $orderby: Sort alerts.

    Example: ?$orderby=CreationTime desc

  3. $top: Limit the number of results returned.

    Example: ?$top=50

  4. $skip: Skip a number of results (paging).

    Example: ?$skip=50&$top=50

  5. $count: Request total count of items.

    note

    Must be a valid Boolean literal: "true" or "false".

Filter examples​

Check out the following filter examples:

  1. By component: ?$filter=component eq 'Process'.

  2. By read state (unread only): ?$filter=component eq 'Process' and state eq 'Unread'.

  3. By severity: The severity field is an enum. Only equality comparisons on severity are supported, for example:

    • severity eq 'Warning'
    • severity in ('Info','Warning')

    Inequality (ne) and range comparisons (gt, ge, lt, le) on severity are not supported and must not be used in $filter expressions.

    For example ?$filter=component eq 'Process' and severity eq 'Warning'.

  4. By time range: ?$filter=component eq 'Process' and creationTime ge 2025-01-01T00:00:00Z and creationTime lt 2025-02-01T00:00:00Z

  5. Search in alert message or context (data): ?$filter=component eq 'Process' and contains(data,'Timeout')

Responses​

200 OK​

In-app alert notifications for the authenticated user were retrieved successfully.

400 Bad Request​

  • Invalid OData query, particularly an invalid $count value (non-Boolean).
  • Response body is a standard JSON error object with a message indicating the invalid count query option.

401 Unauthorized​

Missing or invalid bearer token.

403 Forbidden​

Token valid but does not satisfy the UserContext policy or required permissions.

5xx Server Errors​

Unexpected server-side failures.

Example request​

Request:

curl --location --request GET \
  'https://cloud.uipath.com/{organizationName}/notificationservice_/notificationserviceapi/odata/v1/Alerts?$top=50&$skip=0&$orderby=creationTime desc&$count=true' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'Accept: application/json'

Response:

{
  "value": [
    {
      "id": "<identifier>",
      "notificationName": "Robot.StatusChanged.NotResponding",
      "data": "{\"robotId\": 123, \"machineName\": \"<machineName>\"}",
      "component": "Orchestrator",
      "severity": "Warning",
      "creationTime": "2025-01-01T12:34:56Z",
      "state": "Unread",
      "userNotificationId": "<userNotificationId>",
      "deepLinkRelativeUrl": "/alerts/deeplink/robot-not-responding?robotId=123"
    }
  ],
  "@odata.count": 1
}