--- title: "List of employments with fewer fields for performance reasons" method: GET path: "/v2/providers/employers/{employerId}/employees/employments/minimized" tags: ["Employment"] --- # List of employments with fewer fields for performance reasons `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 __Activity name :__ GetEmploymentsMinimizedByEmployerId 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. ## Path parameters - `employerId` string, uuid, required ## Query parameters - `filter` string - `orderBy` string - `pageNumber` integer - `pageSize` integer ## 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` EmploymentMinimizedResponse20191216[] - `employee` object - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `employeeNumber` integer: The employee number to uniquely identify a employee within a employer. - `firstName` string, nullable: The first name of the employee - `formattedName` string: Formatted name of the employee based on the value of `howToFormatLastName` - `dateOfBirth` string, date: The date of birth - `photo` string, url, nullable: A photo of the employee to use as a avatar/profile picture. 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. - `fullLastName` string: The full last name contains the last name of the employee and - if applicable - the partners last name. Both including infixes. Regardless of `howToFormatLastName` - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this employment starts. NL: DatumInDienst - `commissionUntilDate` string, date, nullable: The date on which the employment will end. NL: AanstellingTot - `endDate` string, date, nullable: The date on which the employment ends. NL: DatumUitDienst - `payrollAdministration` PayrollAdministration20191216, nullable: Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time) `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the payroll administration - `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. - `description` string: Description of the administration - `nonPayrollAdministration` NonPayrollAdministration20191216, nullable: Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time) `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the non payroll administration - `description` string: Description of the administration - `employmentDurationType` EmploymentDurationTypeVerion20191216: A selection of pre defined durations for the employment. NL: SoortDienstverband - `key` integer - `value` string - `incomeRelationshipNumber` integer: The income relationship number that is required in the tax return. Together with the citizen service number (burgerservicenummer, BSN) and wage tax number, the income relationship number uniquely identifies an employment. NL: NummerInkomstenVerhouding - `payrollId` integer: The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning ## 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)