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 model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
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-22 22:57 UTC.
API reference
/
Models
ContinuationPagedResultDtoOfInAppNotificationItemDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Represents a page of results obtained through continuation-token paging.
Supports an approximate total count for display purposes.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description items
required array of InAppNotificationItemDto
array of InAppNotificationItemDto The items returned for this page.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of each InAppNotificationItemDto:
Field
Type
Description id
required string (uuid)
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
eventType
required string
The event type that produced the notification, for example `Transaction.Declined`.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
category
required string
The event type's catalog category, for example `Transactions`.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
title
required string
The notification title.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
body
required string
A short plain-text summary, or `null`.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
actionUrl
required string
A relative in-app path to the record the notification is about, or `null`.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
priority
required InAppNotificationItemPriority
InAppNotificationItemPriority How prominently the notification is shown.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
LowInformational only. NormalA standard notification. HighNeeds attention. CriticalNeeds attention now.
isRead
required boolean
Whether the user has read the notification.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
readAt
required string (date-time)
When the user read the notification (UTC), or `null`.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
createdAtUtc
required string (date-time)
When the notification was written (UTC).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This body has no documented fields.
nextContinuationToken
required string
Continuation token to use when requesting the next page.
Null means no additional pages exist.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
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 Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
pageItemCount
required integer (int32)
Convenience property for the number of items in this page.
read only Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
retrievedAt
required string (date-time)
When the page was retrieved. Useful for diagnostics and cache behavior.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Next steps