LOloket
Employee

List of employees for an employer

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

Get a list of all employees for the given employer

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

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/employees
  • 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

The default option is application/json;version=yyyy-MM-dd. For the export functionality two other options are supported:

  • text/csv;version=yyyy-MM-dd
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;version=yyyy-MM-dd
X-ReportInputstring

Allows the user set what values are returnd in the "export" (csv or excel).

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",
      "employeeNumber": 156,
      "personalDetails": {
        "firstName": "Susan",
        "lastName": "Bergen",
        "prefix": "van",
        "initials": "S.L.",
        "lastNamePartner": "Wiel",
        "prefixPartner": "van de",
        "formattedName": "Wiel - van Bergen S.L. van de",
        "dateOfBirth": "1995-05-21",
        "placeOfBirth": "Amsterdam",
        "aowDate": "2062-08-21",
        "photo": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
        "howToFormatLastName": {
          "key": 2,
          "value": "last name + last name partner"
        },
        "title": {
          "key": 2,
          "value": "e.g. Msc, PHD or Baron"
        },
        "nationality": {
          "key": 2,
          "value": "Dutch"
        },
        "gender": {
          "key": 2,
          "value": "female"
        },
        "civilStatus": {
          "key": 2,
          "value": "Maried"
        }
      },
      "contactInformation": {
        "phoneNumber": "+31 13-1234567",
        "mobilePhoneNumber": "+31 6-1231456",
        "faxNumber": "+31 13-1234561",
        "emailAddress": "info@loket.nl",
        "businessPhoneNumber": "+31 13-1234567",
        "businessMobilePhoneNumber": "+31 6-1231456",
        "businessEmailAddress": "info@loket.nl"
      },
      "identityDocument": {
        "typeOfDocument": {
          "key": 2,
          "value": "Passport"
        },
        "documentIdentification": "CRE45553433"
      },
      "travel": {
        "travelDistanceToWork": 32,
        "travelDistanceToWorkInKm": 41.05
      },
      "address": {
        "street": "Voordijk",
        "city": "Leiden",
        "houseNumber": 12,
        "houseNumberAddition": "D",
        "furtherIndication": {
          "key": 1,
          "value": "WW"
        },
        "postalCode": "1234 AA",
        "location": "Fourth floor or building C",
        "country": {
          "key": 1,
          "value": "Netherlands",
          "isoCode": "NL"
        }
      },
      "deviatingPostalAddress": {
        "street": "Voordijk",
        "city": "Leiden",
        "houseNumber": 12,
        "houseNumberAddition": "D",
        "furtherIndication": {
          "key": 1,
          "value": "WW"
        },
        "postalCode": "1234 AA",
        "location": "Fourth floor or building C",
        "country": {
          "key": 1,
          "value": "Netherlands",
          "isoCode": "NL"
        }
      },
      "statusEmployeeSelfService": {
        "key": 2,
        "value": "Blocked"
      },
      "revokeEmployeeSelfServiceAccessOn": "2018-10-23"
    }
  ]
}

Changes

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