curl --request GET \
--url http://localhost:3000/rs/notifications/v1/ \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/notifications/v1/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/rs/notifications/v1/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/rs/notifications/v1/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/rs/notifications/v1/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/rs/notifications/v1/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/notifications/v1/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "deadline_reminder",
"severity": "alert",
"expectation": "required",
"action": "plan",
"title": "<string>",
"body": "<string>",
"payload": {},
"channels": [
"in_app"
],
"subjectType": "Anomaly",
"subjectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectLabel": "<string>",
"readAt": "2023-11-07T05:31:56Z",
"pinnedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"actions": {
"canBeMarkedRead": true,
"canBeMarkedUnread": true,
"canBePinned": true,
"canBeUnpinned": true,
"canBeDeleted": true
}
}
],
"totalCount": 4503599627370495,
"pagination": {
"page": 4503599627370495,
"pageSize": 4503599627370495,
"totalPages": 4503599627370495
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}List the caller's notification inbox
curl --request GET \
--url http://localhost:3000/rs/notifications/v1/ \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/notifications/v1/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/rs/notifications/v1/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/rs/notifications/v1/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/rs/notifications/v1/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/rs/notifications/v1/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/notifications/v1/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "deadline_reminder",
"severity": "alert",
"expectation": "required",
"action": "plan",
"title": "<string>",
"body": "<string>",
"payload": {},
"channels": [
"in_app"
],
"subjectType": "Anomaly",
"subjectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectLabel": "<string>",
"readAt": "2023-11-07T05:31:56Z",
"pinnedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"actions": {
"canBeMarkedRead": true,
"canBeMarkedUnread": true,
"canBePinned": true,
"canBeUnpinned": true,
"canBeDeleted": true
}
}
],
"totalCount": 4503599627370495,
"pagination": {
"page": 4503599627370495,
"pageSize": 4503599627370495,
"totalPages": 4503599627370495
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
0 < x <= 90071992547409910 < x <= 1000When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.
true
Extend options (JSON-encoded array, e.g. ?extend=["category"]):
- "actions-info": Adds
actions{ canBeMarkedRead, canBeMarkedUnread, canBeDeleted } per row.
actions-info Show child attributes
Show child attributes
Filter by one or more severities (alert, reminder, info).
["alert", "reminder"]
Keyset cursor "|", taken from the last row received. Answers the rows strictly older than it, in the default newest-first order. Unlike page/pageSize it does not shift when a notification arrives between two calls.
200"lobby"
true = unread only, false = read only, omitted = both.
true
true = pinned only, false = unpinned only, omitted = both.
true
true = only types the caller must act on, false = only types that are not, omitted = both.
true