Sign in

v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Announcement

Announcements at provider level.

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

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.

get/v2/providers/employers/announcements

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

includeExpiredboolean
Example:true

Include the read items

includeDescriptionboolean
Example:true

Indicates whether the description should be included in the response.

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