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": { "limit": 10, "page": 1, "totalItems": 142, "totalPages": 15 } }

Query Parameters

limit

number

default:10

Items per page.

Required range: 1 <= x <= 100

page

number

default:1

Page number.

Required range: x >= 1

status

enum<string>

Recipient status.

Available options:

UNREAD,

READ,

ARCHIVED

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

priority

enum<string>

Notification priority.

Available options:

LOW,

NORMAL,

HIGH,

URGENT

resourceDomain

string

Related resource domain.

resource

string

Related resource name.

createdAt

string

Created date range.

sortBy

enum<string>

default:createdAt

Field to sort by.

Available options:

createdAt,

readAt,

priority

sortOrder

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

fields

string

Comma-separated list of fields to include in the response. Supports dot notation.

Response

data

object[]

required

Show child attributes