The get notifications operation will retrieve a single notification, a list of all notifications or a list of all exposed notifications.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/notifications/ |
| GET | https://{company-name}.helloid.com/api/v1/notifications/exposed |
| GET | https://{company-name}.helloid.com/api/v1/notifications/{notificationGuid} |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {notificationGuid} | The GUID of the notification to retrieve |
Request headers
| Parameter | Description |
|---|---|
| Content-Type | Required. Must be set to application/json |
Request body
None.
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors or the request body was malformed. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
| 404(NOT FOUND) | The operation was not successful. The notification has not been found. |
Please also see common HTTP status codes.
Sample response body
{
"notificationGUID": "0a82f9e7-64d5-4b6e-bef0-d45caab22f1f",
"title": {
"en": "Welcome to the HelloID portal",
"nl": "Welkom op het HelloID portal",
"de": "",
"fr": ""
},
"message": {
"en": "Check out you applications and products",
"nl": "Bekijk je applicaties en producten",
"de": "",
"fr": ""
},
"exposed": true,
"icon": "fa-bell",
"type": 0,
"level": 0,
"visibleFromDate": "2018-01-30T13:48:25",
"expireDate": null,
"targetedGroups": []
}
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X GET https://{company-name}.helloid.com/api/v1/notifications/