Skip to content

Loket.nl API API

by loket.nl

No authHTTPSBusiness
Open documentation ↗

Overview

<span style="color:green">**Is this your first time here? Please check out our [introduction to Loket (API)](./Introduction)**</span> **The initial loading time of this developer portal may be very long due to the large number of endpoints designs being rendered when loading the page. We are looking into an alternative solution but for now please bear in mind.** # General The Loket.nl API is a RESTful API that exposes the data and features of the Loket.nl platform. The API accepts and returns JSON and can only be accessed by registered users. This documentation describes version 2 of the API. Are you looking to partner up and start building an integration based on the Loket RESTful API? Please check out the steps for partners on our [website](https://www.loket.nl/koppelingen/koppelen-met-loket/) . Have you received your client and user credentials from us? Check out the following Postman collection to help you start making your first API calls on our acceptance environment. We would recommend to install the Postman desktop app. [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/19604713-42728000-2df3-4ff0-908e-dc6ab410990c?action=collection%2Ffork&collection-url=entityId%3D19604713-42728000-2df3-4ff0-908e-dc6ab410990c%26entityType%3Dcollection%26workspaceId%3Ddde2c409-9fb2-4f40-9981-f937f73750ea#?env%5BLoket.nl%20Test%20Environment%5D=W3sia2V5IjoiQXV0aGVudGljYXRpb25TZXJ2ZXJVcmwiLCJ2YWx1ZSI6Imh0dHBzOi8vb2F1dGgubG9rZXQtYWNjLm5sLyIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJ0ZXh0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9vYXV0aC5sb2tldC1hY2MubmwvIiwic2Vzc2lvbkluZGV4IjowfSx7ImtleSI6Ikxva2V0QXBpVXJsIiwidmFsdWUiOiJodHRwczovL2FwaS5sb2tldC1hY2MubmwvIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiJodHRwczovL2FwaS5sb2tldC1hY2MubmwvIiwic2Vzc2lvbkluZGV4IjoxfSx7ImtleSI6IkNsaWVudF9JZCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5IjoiQ2xpZW50X1NlY3JldCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjN9LHsia2V5IjoiUmVkaXJlY3RfVXJpIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJyZWZyZXNoX3Rva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6NX0seyJrZXkiOiJ0b2tlbiIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjZ9XQ==) Do you want to contact us with any further questions or remarks regarding the Loket RESTful API? Please send an email to [email protected], and we will get back to you. ## Environments The Loket.nl API has two different environments. The first environment is the "acceptance" environment which is used during development and returns test data. The second environment is the production environment which is to be used exclusively by approved applications. Both environments have their own URLs. * The acceptance environment can be accessed at https://api.loket-acc.nl/v2/ * The production environment can be accessed at https://api.loket.nl/v2/ ## OpenAPI documentation The endpoints are defined using the [OpenAPI 3.0 specification](https://github.com/OAI/OpenAPI-Specification), an industry-wide recognized standard for describing REST API's. __Please note:__ the endpoint documentation in this portal is not designed to be fully compatible with any automatic code generation tools. ## Change policy Over the course of time the API, and policies regarding the API can and will change. These changes are subject to the following guidelines. The following states hold true for the change policy for this API. * Loket.nl may sometimes introduce changes to the API and policies without advance notice. * Loket.nl will try to inform users of any (breaking) change in advance. * Loket.nl will not be liable to you or any third party for such modifications or any adverse effects resulting from such modifications. * Loket.nl will try to avoid brea

Loket.nl API is a business API from loket.nl. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 641 endpoints.

At a glance

Authentication
No auth
HTTPS
Yes
CORS
Unknown
Category
Business
Base URL
https://api.loket.nl/v2
Version
V2
Endpoints
641
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.loket.nl/v2/achmeainsurancecontracts" \
  -H "Accept: application/json"
JavaScript
const response = await fetch("https://api.loket.nl/v2/achmeainsurancecontracts", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.loket.nl/v2/achmeainsurancecontracts",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/achmeainsurancecontractslist of insurance contracts
GET/achmeainsurancecontracts/{achmeaInsuranceContractId}/insuredwagecalculationpercentageslist of wage percentages for an insurance contract
GET/aowDateAcquire the AOW date
GET/applications/{applicationId}/authorizationsAuthorizations for the application
GET/applications/{applicationId}/logoDownload the application logo
GET/chamberofcommerce/{chamberOfCommerceNumber}/companyinformationAcquire company information
GET/datanewbusiness/functionsGet a list of functions
GET/datanewbusiness/tokenGet Data New Business token
GET/locationservices/addressAcquire the address for a combination of `postalCode` and `houseNumber`
GET/providersList of providers
PUT/providers/applicationsets/{applicationSetId}Edit the details of an applicationset
DELETE/providers/applicationsets/{applicationSetId}Delete a specific applicationset
GET/providers/authorizationsets/{authorizationsetid}Details of a authorization set
DELETE/providers/emailidentities/{emailIdentityId}Delete an EmailIdentity for a provider
POST/providers/emailidentities/{emailIdentityId}/sendtestemailProvider emailIdentity test email
GET/providers/employersList of employers
PATCH/providers/employers/announcementsMark one or more announcements as read.
GET/providers/employers/benefitinkindtypes/{benefitInKindTypeId}Details of an benefit in kind type
PUT/providers/employers/benefitinkindtypes/{benefitInKindTypeId}Edit an benefit in kind type record
DELETE/providers/employers/benefitinkindtypes/{benefitInKindTypeId}Delete an benefit in kind type record
PATCH/providers/employers/conceptemployees/import/{payrollAdministrationId}Import concept employees via a file
GET/providers/employers/conceptemployees/metadata/payrollAdministration/{payrollAdministrationId}/payScale/{payscaleKey}/paygrade/{paygradeKey}Paygrade metadata for concept employee
GET/providers/employers/conceptemployees/minimized/{conceptEmployeeId}Details of a concept employee with fewer fields.
PUT/providers/employers/conceptemployees/minimized/{conceptEmployeeId}Edit the details of a concept employee with fewer fields.
GET/providers/employers/conceptemployees/{conceptEmployeeId}Details of a concept employee
PUT/providers/employers/conceptemployees/{conceptEmployeeId}Edit the details of a concept employee
DELETE/providers/employers/conceptemployees/{conceptEmployeeId}Delete a concept employee
POST/providers/employers/conceptemployees/{conceptEmployeeId}/assessment/initiateInitiate assessment
GET/providers/employers/conceptemployees/{conceptEmployeeId}/citizenservicenumberCitizen service number of a concept employee
PUT/providers/employers/conceptemployees/{conceptEmployeeId}/citizenservicenumberUpdate the citizen service number of a concept employee
PATCH/providers/employers/conceptemployees/{conceptEmployeeId}/convertToEmployeeConvert a concept employee to an employee
GET/providers/employers/conceptemployees/{conceptEmployeeId}/documentsGet a list of concept employee dossier documents
POST/providers/employers/conceptemployees/{conceptEmployeeId}/documentsUpload a document to the concept employee dossier
GET/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}Download concept employee dossier document
PUT/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}Edit the details of an concept employee dossier document
DELETE/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}Delete a document in the concept employee dossier
GET/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/audittrailGet audittrail for the document in the concept employee dossier
GET/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signatureSignature details - Conceptemployee
DELETE/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signatureDelete signature - Conceptemployee
POST/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signature/initiateInitiate signature - Conceptemployee
GET/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signature/reportRetrieve the report of the signing - Conceptemployee
POST/providers/employers/conceptemployees/{conceptEmployeeId}/documenttemplates/{documentId}/generatedocumentGenerate a document for an concept employee
POST/providers/employers/conceptemployees/{conceptEmployeeId}/documenttemplates/{documentId}/generatedocument/previewGenerate a document for an concept employee - preview
GET/providers/employers/conceptemployees/{conceptEmployeeId}/dossier"Document count
DELETE/providers/employers/conceptemployees/{conceptEmployeeId}/dossier"Delete the complete concept employee dossier
POST/providers/employers/conceptemployees/{conceptEmployeeId}/preboardingtrajectoryAdd a preboarding trajectory
PATCH/providers/employers/conceptemployees/{conceptEmployeeId}/preboardingtrajectoryChange status of a preboarding trajectory
GET/providers/employers/conceptemployees/{conceptEmployeeId}/selfserviceDetails of a Concept employee self service portal status
GET/providers/employers/contractcodes/{contractCodeId}Details of a contract code
PUT/providers/employers/contractcodes/{contractCodeId}Edit a contract code record
DELETE/providers/employers/contractcodes/{contractCodeId}Delete a contract code record
GET/providers/employers/customfields/{customFieldId}Details of a custom field
PUT/providers/employers/customfields/{customFieldId}Edit a custom field record
DELETE/providers/employers/customfields/{customFieldId}Delete a custom field record
GET/providers/employers/customholidays/{customHolidayId}Details of a custom holiday
PUT/providers/employers/customholidays/{customHolidayId}Edit a custom holiday record
DELETE/providers/employers/customholidays/{customHolidayId}Delete a custom holiday record
GET/providers/employers/departments/{departmentId}Details of a department
PUT/providers/employers/departments/{departmentId}Edit the details of a department
GET/providers/employers/educationfurtherindications/{educationFurtherIndicationId}Details of an education further indication
PUT/providers/employers/educationfurtherindications/{educationFurtherIndicationId}Edit an education further indication record
DELETE/providers/employers/educationfurtherindications/{educationFurtherIndicationId}Delete an education further indication record
GET/providers/employers/educationtypes/{educationTypeId}Details of an education type
PUT/providers/employers/educationtypes/{educationTypeId}Edit an education type record
DELETE/providers/employers/educationtypes/{educationTypeId}Delete an education type record
DELETE/providers/employers/emailidentities/{emailIdentityId}Delete an EmailIdentity for an employer
POST/providers/employers/emailidentities/{emailIdentityId}/sendtestemailEmployer emailIdentity test email
GET/providers/employers/employees/absences/absencecontactHistory/{absencecontactHistoryId}Details of a contact history
PUT/providers/employers/employees/absences/absencecontactHistory/{absencecontactHistoryId}Edit the details of a contact history
DELETE/providers/employers/employees/absences/absencecontactHistory/{absencecontactHistoryId}Delete a specific record
GET/providers/employers/employees/absences/absenceprogress/{absenceProgressId}Details of an Absence Progress
PUT/providers/employers/employees/absences/absenceprogress/{absenceProgressId}Edit the details of an absence progress
DELETE/providers/employers/employees/absences/absenceprogress/{absenceProgressId}Delete a specific Absence Progress record
GET/providers/employers/employees/absences/{absenceId}Details of an Absence
PUT/providers/employers/employees/absences/{absenceId}Edit the details of a Absence
DELETE/providers/employers/employees/absences/{absenceId}Delete a specific absence record
GET/providers/employers/employees/absences/{absenceId}/absencecontactHistoryContact history for an absence
POST/providers/employers/employees/absences/{absenceId}/absencecontactHistoryCreate a contact history for an Absence
GET/providers/employers/employees/absences/{absenceId}/absenceprogressList of absence progress for an absence
POST/providers/employers/employees/absences/{absenceId}/absenceprogressCreate an Absence Progress for an Absence
PATCH/providers/employers/employees/absences/{absenceId}/closeabsenceClose an absence
PATCH/providers/employers/employees/absences/{absenceId}/reopenabsenceReopen an absence
GET/providers/employers/employees/children/{childId}Details of a child
PUT/providers/employers/employees/children/{childId}Edit the details of a child
DELETE/providers/employers/employees/children/{childId}Delete a specific child record
GET/providers/employers/employees/contacts/{contactId}Details of a single contact
PUT/providers/employers/employees/contacts/{contactId}Edit a contact
DELETE/providers/employers/employees/contacts/{contactId}Delete a specific contact
GET/providers/employers/employees/customfields/{employeeCustomFieldId}Details of an employee custom field
PUT/providers/employers/employees/customfields/{employeeCustomFieldId}Edit an employee custom field record
DELETE/providers/employers/employees/customfields/{employeeCustomFieldId}Delete an employee custom field record
GET/providers/employers/employees/educations/{employeeEducationId}Details of a single education
PUT/providers/employers/employees/educations/{employeeEducationId}Edit a Education
DELETE/providers/employers/employees/educations/{employeeEducationId}Delete a specific education
PATCH/providers/employers/employees/employments/WageProposalsAccept or reject wage proposals
GET/providers/employers/employees/employments/abpfunds/{abpFundId}Details of an abp fund
PUT/providers/employers/employees/employments/abpfunds/{abpFundId}Edit a abp fund record
DELETE/providers/employers/employees/employments/abpfunds/{abpFundId}Delete a specific abp fund record
GET/providers/employers/employees/employments/attachmentsofearnings/{attachmentOfEarningsId}Get the details of an attachment of earnings record
PUT/providers/employers/employees/employments/attachmentsofearnings/{attachmentOfEarningsId}Edit the details of an attachment of earnings record

Showing the first 100 of 641 endpoints; the full list is in the documentation.

Questions

Does the Loket.nl API API need an API key?

No. The Loket.nl API API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the Loket.nl API API support HTTPS?

Yes, the Loket.nl API API is served over HTTPS.

How many endpoints does the Loket.nl API API have?

Its OpenAPI description lists 641 endpoints in version V2. The first 100 are shown on this page.

What are alternatives to the Loket.nl API API?

Other Business APIs include Gmail, Google Analytics, Apache Superset, Trello, Square.

Compare alternatives →

Listed from APIs.guru (CC0).