--- title: "Announcements at provider level." method: GET path: "/v2/providers/employers/announcements" tags: ["Announcement"] --- # Announcements at provider level. `GET /v2/providers/employers/announcements` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/announcements` - Auth: none required __Activity name :__ GetAnnouncementsByBearerToken Returns an array of announcements for the current user. By default the list includes announcements that are unread and not expired. An announcements has a subject and a description. The subject is always included. By default the description is not included in the response. Use the includeDescription parameter to include the description in the response. ## Query parameters - `filter` string - `orderBy` string - `pageNumber` integer - `pageSize` integer - `includeRead` boolean - `includeExpired` boolean - `includeDescription` boolean ## 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` AnnouncementProvider[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `employerId` string, uuid: The unique identifier of an object (GUID/UUID) - `employerName` string: Name of the administration - `employerLogo` string, url, nullable: The location of the logo of the employer. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. - `employer` Employer2 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `companyName` string: Name of the company - `employerNumber` integer: The employer number is used in various overviews and exports to identify a specific employer in Loket (please note: this is not the identifier used in the REST API). - `administrationNumber` string, nullable: A free field that is most commonly used to store the Debtors Number the provider uses for the employer. This field is used as a key field in some of the existing SOAP webservices. - `groupCode` integer, nullable: The groupcode is used for grouping employers. It is used for filtering output and processes (only include employers in group 40 in this report). - `payrollAdministration` PayrollAdministration, nullable - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: The name of the payroll administration. This is the name that is used in the Loket interface. - `shortName` string, nullable: Shortened name of the administration - `administrationNumber` string, nullable: A free field that is most commonly used to store the Debtors Number the provider uses for the employer. This field is used as a key field in some of the existing SOAP webservices. - `clientNumber` integer: The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling. - `groupCode` integer, nullable: The groupcode is used for grouping employers. It is used for filtering output and processes (only include employers in group 40 in this report). - `groupClassification` object, nullable: The group classification for the payroll administration. This field is used for filtering and grouping within the interface. `groupClassification` is a metadata field within the provider context. Possible values can be managed by the user. - `key` integer - `value` string - `payrollPeriodType` object: Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). - `key` integer - `value` string - `cla` object: The CAO (CLA -> collective labor agrement) of the "loonmodel" the payroll administration is linked to. - `key` integer - `value` string - `wagemodel` object: The "loonmodel" (this is a Loket term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible. `loonmodel` is a metadata field within the provider context. Possible values can be managed by the user. - `key` integer - `value` string - `isRead` boolean: Indicates whether the announcement has been read - `isExpired` boolean: Indicates whether the announcement has expired. - `creationDate` string, date: The date on which the announcement was announced. - `effectiveDate` string, date: The date on which the announcement takes effect - `expirationDate` string, date, nullable: The date on which the announcement expires - `subject` string: subject of the announcement - `description` string: description of the announcement ## 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)