API Stability Long-Term

The listNotifications() GraphQL query returns a all of the notifications currently in the system. It requires organization ownership.

To add a notification, you can use the notify() mutation field. You can dismiss one with the dismissNotification() mutation and delete one with deleteNotification().

To access the notifications through the UI, see the Notifications page in the main documentation. For more information on actions, previously known as notifiers, see the Actions page.

Syntax

graphql
listNotifications: [Notification]!

There aren't any values to give for this query field. For the results, though there are many values you can request (e.g., the notification message, the severity, and the type). See the Returned Datatype section for more possibilities.

Example

Below is an example using this query field:

Raw
graphql
query {
  listNotifications 
     { id, title, 
       severity, message }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  listNotifications 
     { id, title, 
       severity, message }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  listNotifications 
     { id, title, 
       severity, message }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
  listNotifications  ^
     { id, title,  ^
       severity, message } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  listNotifications 
     { id, title, 
       severity, message }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "query {
  listNotifications 
     { id, title, 
       severity, message }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
  listNotifications 
     { id, title, 
       severity, message }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
  listNotifications 
     { id, title, 
       severity, message }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "listNotifications": []
  }
}

Returned Datatype

With the returned datatype, you can get the heading for the notice, the message itself, the severity level, and other elements of the notification. The table below and links to other datatypes lists your choices:

Table: Notification

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Jun 23, 2025
dismissablebooleanyes Long-TermWhether the notification is dismissable.
idstringyes Long-TermThe unique identifier for the notification.
linkstring  Long-TermLink accompanying the notification.
linkDescriptionstring  Long-TermA description for the link.
messagestringyes Long-TermThe message for the notification.
severityNotificationSeverityyes Long-TermThe severity of the notification. See NotificationSeverity.
titlestringyes Long-TermThe title or heading of the notification.
typeNotificationTypesyes Long-TermThe type of the notification. See NotificationTypes.