- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
Retrieve in-app alert notifications for the authenticated user via the Test Cloud Alerts API endpoint.
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 platform | Access URL |
|---|---|
| Test Cloud | https://cloud.uipath.com/ |
| Test Cloud Public Sector | https://govcloud.uipath.us/ |
| Test Cloud Dedicated | https://{customURL}.dedicated.uipath.com/ |
Request headers
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Query parameters
The endpoint supports standard OData query options on the Alerts collection:
-
$filter: Filter alerts.Example:
?$filter=Severity eq 'High' -
$orderby: Sort alerts.Example:
?$orderby=CreationTime desc -
$top: Limit the number of results returned.Example:
?$top=50 -
$skip: Skip a number of results (paging).Example:
?$skip=50&$top=50 -
$count: Request total count of items.Note:Must be a valid Boolean literal:
"true"or"false".
Filter examples
Check out the following filter examples:
-
By component:
?$filter=component eq 'Process'. -
By read state (unread only):
?$filter=component eq 'Process' and state eq 'Unread'. -
By severity: The
severityfield is an enum. Only equality comparisons onseverityare supported, for example:severity eq 'Warning'severity in ('Info','Warning')
Inequality (
ne) and range comparisons (gt,ge,lt,le) onseverityare not supported and must not be used in$filterexpressions.For example
?$filter=component eq 'Process' and severity eq 'Warning'. -
By time range:
?$filter=component eq 'Process' and creationTime ge 2025-01-01T00:00:00Z and creationTime lt 2025-02-01T00:00:00Z -
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
$countvalue (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'
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
}
{
"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
}