Skip to main content
GET
List Notifications

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:10

Items per page

Example:

10

page
number
default:1

Page number

Example:

1

createdAt
string

Created at range

Example:

">=2024-01-01;<=2024-12-31"

priority
enum<string>

Notification priority

Available options:
LOW,
NORMAL,
HIGH,
URGENT
Example:

"NORMAL"

resource
string

Related resource

Example:

"SUPPORT_CASE"

resourceDomain
string

Related resource domain

Example:

"SUPPORT"

status
enum<string>

Recipient status

Available options:
UNREAD,
READ,
ARCHIVED
Example:

"UNREAD"

type
enum<string>

Notification type

Available options:
SUPPORT_CASE_CREATED,
SUPPORT_CASE_MESSAGE_CREATED,
SUPPORT_CASE_ASSIGNED,
SUPPORT_CASE_STATUS_CHANGED,
ROUTE_APPROVAL_REQUESTED,
ROUTE_APPROVED,
ROUTE_REJECTED,
TRIP_STATUS_CHANGED,
TRIP_EVENT_RECORDED,
OPERATIONAL_GUARD_ALERT,
PAYMENT_CONFIRMED,
PAYMENT_FAILED,
TRANSFER_PROCESSED,
TRANSFER_FAILED,
ORDER_CONFIRMED,
ORDER_CANCELLED,
TICKET_CANCELLED,
BENEFIT_REQUEST_APPROVED,
BENEFIT_REQUEST_REJECTED,
EXPORT_COMPLETED,
EXPORT_FAILED
Example:

"SUPPORT_CASE_CREATED"

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
readAt,
priority
Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Notification inbox page

data
object[]
required
meta
object
required