LOloket
Employment

List of employments with fewer fields for performance reasons

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

Get a list of employments for an employer. With this version we introduced the "Minimized" resource which contains fewer fields. This version should increase performance when requesting employments for large employer.

This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.

get/v2/providers/employers/{employerId}/employees/employments/minimized

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/employees/employments/minimized
  • Auth
    none required

Path parameters

employerIdstring uuid required

The unique identifier of the employer

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

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

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

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": [
    {
      "employee": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "employeeNumber": 156,
        "firstName": "Susan",
        "formattedName": "Wiel - van Bergen S.L. van de",
        "dateOfBirth": "1995-05-21",
        "photo": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
        "fullLastName": "van de Wiel van Bergen"
      },
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "startDate": "2018-01-01",
      "commissionUntilDate": "2019-01-01",
      "endDate": "2018-10-23",
      "payrollAdministration": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "name": "ABC accountants",
        "clientNumber": 1234,
        "description": "Bakker"
      },
      "nonPayrollAdministration": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "name": "HR only employees",
        "description": "Bakker"
      },
      "employmentDurationType": {
        "key": 1,
        "value": "Contract of indefinite duration"
      },
      "incomeRelationshipNumber": 12,
      "payrollId": 2
    }
  ]
}

Changes

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