View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-01 06:25 UTC.

API reference Notifications

Lists the caller's notifications, newest first.

GET /api/notifications/inbox deprecated

No permission required.

Continuation-paged: pass the `nextToken` from one page as `continuationToken` to read the next. Narrow by `category` or by `isRead`.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a . See the Request body section below for its fields.

Code sample language

cURL
curl -X GET "{{BASE_URL}}/api/notifications/inbox" \
  -H "api-key: {{API_KEY}}"

PowerShell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/notifications/inbox' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)
import { Configuration, NotificationsApi } from '@winkpg/winkpg-api';

const api = new NotificationsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.notificationsGetInboxList();

TypeScript (raw HTTP)
const response = await fetch('{{BASE_URL}}/api/notifications/inbox', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new NotificationsApi(config);
var result = await api.NotificationsGetInboxListAsync();

C# (raw HTTP)
using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/notifications/inbox");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.NotificationsApi(client)
    result = api.notifications_get_inbox_list()

pip install requests

Python (raw HTTP)
import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/notifications/inbox",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description
Category required query string Narrows to one catalog category, for example `Transactions`.
IsRead required query boolean Narrows to read (`true`) or unread (`false`) notifications.
MaxResultCount required query integer (int32)
ContinuationToken required query string
IncludeDeleted required query boolean
IncludeInactive required query boolean
IncludeApproxTotalCount required query boolean Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count.
Sorting.Field required query string
Sorting.Descending required query boolean
Filter.Logic required query FilterLogic
Filter.Rules required query array of FilterRule
Filter.Groups required query array of FilterGroup
suppressNulls required query boolean If true, omit properties with null values.

Request body

application/json , required

Field Type Description

This request body has no documented fields.

Responses

200 One page of the caller's notifications.

Body: ContinuationPagedResultDtoOfInAppNotificationItemDto Each item has these fields.

Field Type Description
items required array of InAppNotificationItemDto The items returned for this page. nullable
nextContinuationToken required string Continuation token to use when requesting the next page. Null means no additional pages exist. nullable
approxTotalCount required integer (int64) An approximate total count of matching items. This value is optional and may be stale or estimated, so treat it as an approximation. nullable
pageItemCount required integer (int32) Convenience property for the number of items in this page. read only
retrievedAt required string (date-time) When the page was retrieved. Useful for diagnostics and cache behavior.

This response has no documented body fields.

400 The page size, sort field or filter field is not supported.

Body: Each item has these fields.

Field Type Description

This response has no body.

401 The caller is not signed in.

Body: Each item has these fields.

Field Type Description

This response has no body.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded. Wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling.

Body: RateLimitProblemDetails Each item has these fields.

Field Type Description
type required string The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. nullable
title required string A short, human-readable summary of the problem type. nullable
status required integer (int32) The HTTP status code, repeated in the body as the problem-details format defines.
detail required string A human-readable explanation of this occurrence of the problem. nullable
retryAfterSeconds required integer (int32) How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Notifications

Authentication

    Reconnecting to the server

    Could not reconnect

    This session has ended

    Attempt 1

    Your work on this page is still here. Retrying keeps it; reloading starts the page again.

    The server no longer holds this page's state, so it has to be loaded again.