EntityUserNotifications

Get All

GET
https://api.mercoa.com/entity/:entityId/user/:userId/notifications

Path parameters

entityId
string
userId
string

Query parameters

startDate
optional datetime

Start date for notification created on date filter.

endDate
optional datetime

End date for notification created date filter.

orderDirection
optional enum

Direction to order notifications by. Defaults to asc.

Allowed values: ASCDESC
limit
optional integer

Number of invoices to return. Limit can range between 1 and 100, and the default is 10.

startingAfter
optional string

The ID of the notification to start after. If not provided, the first page of invoices will be returned.

notificationType
optional enum

The type of notification to filter by.

Response

This endpoint return an object.
count
integer

Total number of notifications for the given start and end date filters. This value is not limited by the limit parameter. It is provided so that you can determine how many pages of results are available.

hasMore
boolean

True if there are more notifications available for the given start and end date filters.

data
list of objects
GET
/entity/:entityId/user/:userId/notifications
curl -G https://api.mercoa.com/entity/:entityId/user/:userId/notifications \
-H "Authorization: Bearer <token>" \
-d startDate=2023-01-01T00:00:00Z \
-d endDate=2023-01-01T00:00:00Z
Response
{
"count": 0,
"hasMore": true,
"data": [
{
"id": "string",
"type": "INVOICE_APPROVAL_NEEDED",
"createdAt": "2023-01-01T00:00:00Z",
"invoiceId": "string"
}
]
}