API Specifications
What's NewUKG.comMarketplaceUKG Pro status

Retrieve Bulk Notifications

post https://{hostname}/api/v1/commons/notifications/apply_read

This operation returns a list of all new or reviewed notifications according to the access privileges of the logged-in user. Notifications are further filtered according to the provided category for the selected timeframe or based on the person IDs contained in the specified Hyperfind.

The associated Access Control Point is NOTIFICATION_API_V1.

Service limit

A service limit constrains the total number of notifications returned and the number of notifications returned in each paginated response page.

  • The Total Number of Notifications cannot exceed 50,000.

  • The Number of Notifications in Each Page cannot exceed 1,000.

Refer to the Limits topic for more information.

Details

The types array accepts the following values:

typedomain
ATTENDANCEattendance
HCA_TRANSACTIONAL_DATA_PROCESSHCA
AUDITOR_RUNKPIF
KPI_Historical_LoadKPIF
LEAVEleave
LEAVE_REQUESTleave
DATE_BASED_NOTIFICATIONleave
LIMIT_BASED_NOTIFICATIONleave
DOCUMENT_REMINDERleave
ANNOUNCEMENTSplatform
PROACTIVELY_GUIDE_EMPLOYEESplatform
Integration_Completedplatform
Integration_Startedplatform
Reference_Table_Upload_Completedplatform
Reference_Table_Upload_Failedplatform
Integration_Completed_Notificationplatform
SCHEDULEREPORTreporting
VisibilityPeriodscheduler
PostSchedulescheduler
UnPostSchedulescheduler
RepostAfterEditscheduler
FILL_OPEN_SHIFTscheduler
FILL_OPEN_SHIFT_OUTCOMEscheduler
INACTIVE_REQUESTscheduler
NOTIFY_MY_COLLEAGUESscheduler
TIME_OFFscheduler
AVAILABILITY_REQUESTscheduler
TIMECARD_CHANGE_REQUESTscheduler
AVAILABILITY_PATTERN_REQUESTscheduler
OPEN_SHIFTscheduler
SELF_SCHEDULEscheduler
COVERscheduler
SWAPscheduler
EMP_MEAL_BREAK_OVERTIMEtimekeeper
EMP_MISSED_PUNCH_EXCEPTIONtimekeeper
TIMECARD_REQUEST_REVIEWtimekeeper
requestPeriodtimekeeper
Timekeepingtimekeeper
WORKFLOW_TASKworkflow
Language
Credentials
Bearer
JWT
URL