EntityUserNotifications

Get All

GET

Path parameters

entityIdstringRequired
userIdstringRequired

Query parameters

startDatedatetimeOptional
Start date for notification created on date filter.
endDatedatetimeOptional
End date for notification created date filter.
orderDirectionenumOptional
Direction to order notifications by. Defaults to asc.
limitintegerOptional
Number of invoices to return. Limit can range between 1 and 100, and the default is 10.
startingAfterstringOptional
The ID of the notification to start after. If not provided, the first page of invoices will be returned.
notificationTypeenumOptional
The type of notification to filter by.

Response

This endpoint returns 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
$curl -G https://api.mercoa.com/entity/%3AentityId/user/%3AuserId/notifications \
> -H "Authorization: Bearer <token>" \
> --data-urlencode startDate=2023-01-01T00:00:00Z \
> --data-urlencode endDate=2023-01-01T00:00:00Z
Response
1{
2 "count": 0,
3 "hasMore": true,
4 "data": [
5 {
6 "id": "string",
7 "type": "INVOICE_APPROVAL_NEEDED",
8 "createdAt": "2023-01-01T00:00:00Z",
9 "invoiceId": "string"
10 }
11 ]
12}