notifications

Returns all notifications the user has access to

notifications(
  page: Int
  limit: Int
): NotificationCollection

Arguments

notifications.page ● Int scalar

notifications.limit ● Int scalar

Type

NotificationCollection object

NotificationCollection type

Example request

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"query GetNotifications {\n  notifications { collection { id author { __typename } company { __typename } } metadata { currentPage limitValue totalCount } }\n}","variables":{}}'

JavaScript

const response = await fetch('https://api.convisoappsec.com/graphql', {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'x-api-key': process.env.CONVISO_API_KEY,
  },
  body: JSON.stringify({
    query: "query GetNotifications {\n  notifications { collection { id author { __typename } company { __typename } } metadata { currentPage limitValue totalCount } }\n}",
    variables: {},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

import json
import os
import requests

response = requests.post(
    'https://api.convisoappsec.com/graphql',
    headers={
        'content-type': 'application/json',
        'x-api-key': os.environ['CONVISO_API_KEY'],
    },
    json={
        'query': "query GetNotifications {\n  notifications { collection { id author { __typename } company { __typename } } metadata { currentPage limitValue totalCount } }\n}",
        'variables': json.loads("{}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])