List Notifications - Documentação DEVMOB

{ "data": [ { "notificationRecipientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "notificationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "recipientUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deliveredAt": "2023-11-07T05:31:56Z", "readAt": "2023-11-07T05:31:56Z", "archivedAt": "2023-11-07T05:31:56Z", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" } ], "meta": { "page": 1, "limit": 20, "total": 125, "totalPages": 7 } }

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

Required range: 1 <= x <= 100

Example:

10

page

number

default:1

Page number

Required range: x >= 1

Example:

1

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,

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:

"ROUTE_APPROVAL_REQUESTED"

priority

enum<string>

Notification priority

Available options:

LOW,

NORMAL,

HIGH,

URGENT

Example:

"NORMAL"

resourceDomain

string

Related resource domain

Example:

"OPERATIONS"

resource

string

Related resource name

Example:

"ROUTE_APPROVAL"

createdAt

string

Created date range

Example:

">=2026-07-01;<=2026-07-31"

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

data

object[]

required

Show child attributes