LOloket
Notification

Notifications at providerlevel.

Activity name : <a href="https://developer.loket.nl/Activities/GetNotificationsByBearerToken" target="_blank">GetNotificationsByBearerToken</a>

Returns an array of notifications which are accessible for the current user. The list contains a isRead parameter. The list is structured by employer and administration level.

get/v2/providers/employers/notifications

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/notifications
  • Auth
    none required

Query parameters

filterstring
Example:cancellationPeriodTimeUnit.key eq 4

Filter the collection

orderBystring
Example:-companyName,address.houseNumber

Order the collection on one or more fields

pageNumberinteger
Example:2

Specifies which page should be returned

pageSizeinteger
Example:20

Specifies the number of objects per page

includeReadboolean
Example:true

Include the read items

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:responseType=async;text/csv

The accept header is used to influence what type of output is returned and in most cases the version of the output

The output of the endpoint is provided async or sync. The default option is application/json. These are the supported options:

  • application/json
  • text/csv
  • responseType=async;text/csv
  • responseType=async;application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Response

OK

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "employerName": "VST Consultancy",
      "employerLogo": "https://api.loket.nl/v2/v2/providers/employers/{guid}/logo/{version}",
      "employer": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "companyName": "Voorbeeld B.V.",
        "employerNumber": 20720,
        "administrationNumber": "SR2",
        "groupCode": 40
      },
      "payrollAdministration": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "name": "Voorbeeld B.V. - Payroll",
        "shortName": "ABC adm",
        "administrationNumber": "SR2",
        "clientNumber": 1234,
        "groupCode": 40,
        "groupClassification": {
          "key": 3,
          "value": "South"
        },
        "payrollPeriodType": {
          "key": 2,
          "value": "month"
        },
        "cla": {
          "key": 184,
          "value": "Agriculture"
        },
        "wagemodel": {
          "key": 184,
          "value": "Foresting monthly payrolling"
        }
      },
      "nonPayrollAdministration": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "name": "Voorbeeld B.V. - Non payroll"
      },
      "notificationType": {
        "key": 1,
        "value": "Verjaardag"
      },
      "notificationTypeClarification": "30 Jaar",
      "notificationDate": "2018-02-05",
      "markedAsReadBy": "Jong, I",
      "markedAsReadOn": "2018-02-05T12:29:44+02:00",
      "appliesToEmployee": {
        "formattedName": "Jong, I",
        "employeeNumber": 156
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 6 revisions of this API.