---
title: "The event notification configuration for a payroll administration"
method: GET
path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/eventnotificationconfigurations"
tags: ["Event notification configuration"]
---

# The event notification configuration for a payroll administration

`GET /v2/providers/employers/payrolladministrations/{payrollAdministrationId}/eventnotificationconfigurations`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/eventnotificationconfigurations`
- Auth: none required

__Activity name :__ <a href="https://developer.loket.nl/Activities/GetEventNotificationConfigurationsByPayrollAdministrationId" target="_blank">GetEventNotificationConfigurationsByPayrollAdministrationId</a>

Get a list of the notification configurations for certain events for an employer. Currently its only possible to configure email recipients for an event notification.

__Note:__ Event notifications can be configured on payroll administration and provider level. This endpoint returns the provider level value if no value exists on the payroll administration level and if neither level has a value an empty event is returned.

## Path parameters

- `payrollAdministrationId` string, uuid, required

## Query parameters

- `filter` string
- `orderBy` string
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Authorization` string, required
- `Accept` string, required

## Response `200`

OK

- object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.
  - `totalSize` integer: Total number of records, taking into account the given filter.
  - `pageSize` integer: Number of records in the response
  - `totalPages` integer: Number of pages available
  - `currentPage` integer: Current page returned in the response
  - `version` Version
    - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available
    - `resourceVersion` string, date: The resource version of the object in the response
  - `messages` object[]
    - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages)
    - `description` string: Describes the message
    - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity
    - `code` integer: Identifying code for the message
    - `properties` string[]: An array that can contain additional information
  - `_embedded` EventNotification[]
    - `type` Type: The type of the event
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `description` string: The description of the event.
      - `sortOrder` integer: A number used to sort the list.
    - `category` Category2: The category to which the event belongs
      - `key` integer: The id of the categorie to which the event belongs.
      - `value` string: The name of the categorie to which the event belongs.
    - `dependsOnModule` DependsOnModule: The module to which the event belongs
      - `id` string, uuid: The id of the module to which the event belongs.
      - `description` string: The name of the module to which the event belongs.
    - `definedAtLevel` 'Provider' | 'PayrollAdministration', nullable: The level at which the event is defined. In the 'ByProvider' endpoints the payroll administration level is not used.
    - `emailAddress` string, nullable: The e-mail address that will receive the notification. It is possible to configure multiple addresses by dividing them with a ;

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)