---
title: "retrieve the info of a worker"
method: GET
path: "/public/onboarding/v1/get-worker-details"
tags: ["Onboarding flow"]
---

# retrieve the info of a worker

`GET /public/onboarding/v1/get-worker-details`

## Request

- Base URL: `https://api.maqqie.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.maqqie.app/public/onboarding/v1/get-worker-details`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://maqqie.app/auth/realms/maqqie/protocol/openid-connect/token`
- TypeScript: <https://skmtc.dev/maqqie/apis/maqqie-public-api/docs/public/onboarding/v1/get-worker-details/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `workerId` string, uuid, required

## Response `200`

Successfully retrieved a worker

- WorkerDetailsResponseV1
  - `firstName` string, required
  - `emailAddress` string, email, required
  - `mobilePhoneNumber` string, required
  - `paymentDetails` PaymentDetailsV1, required: Payment details.
    - `IBAN` string, required: The IBAN of the worker.
  - `address` AddressDetailsV1, required: Address details.
    - `street` string, required: The street name of the address.
    - `houseNumber` integer, required: The house number of the address, excluding suffix. For a house number 123A, this would be 123.
    - `houseNumberAddition` string: House number suffix (if any). For a house number 123A, this would be 'A'.
    - `zipCode` string, required: The postal code of the address. Must be a post code that actually exists in the Netherlands.
    - `city` string, required: The city of the address.
    - `countryCode` string, required: The country code in ISO 3166-1 alpha-2 format.

## Other responses

- `400`: The request could not be processed. This could be due to a number of reasons: * The request does not have all required data. * Data in the request is invalid. * Data in the request is inconsistent. * The operation is not allowed given the current state of the data.
- `401`: The request did not contain credentials identifying the caller, or the provided credentials were invalid.
- `403`: The data that the request referred to is inaccessible to the caller.

## Changes

- **2026-09-29** `f9510f3f4b22`: 2 breaking, 5 info
  - the response's body type changed from no type to `object` for status `200`
  - the response's body type changed from no type to `string` for status `400`
  - added the required property `address` to the response with the `200` status
  - added the required property `emailAddress` to the response with the `200` status
  - …3 more
- **2026-09-29** `3352b56bb8fe`: 7 breaking, 14 info
  - the response's body type changed from `object` to no type for status `200`
  - the response's body type changed from `string` to no type for status `400`
  - removed the required property `address` from the response with the `200` status
  - removed the required property `emailAddress` from the response with the `200` status
  - …17 more
- **2026-09-16** `ccf9834e5006`: 2 breaking, 5 info
  - the response's body type changed from no type to `object` for status `200`
  - the response's body type changed from no type to `string` for status `400`
  - added the required property `address` to the response with the `200` status
  - added the required property `emailAddress` to the response with the `200` status
  - …3 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/maqqie/apis/maqqie-public-api/changes/public/onboarding/v1/get-worker-details/get.md)

---

[API](https://skmtc.dev/maqqie/apis/maqqie-public-api.md) - [All operations](https://skmtc.dev/maqqie/apis/maqqie-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/maqqie/apis/maqqie-public-api/revisions/13ed331da2b2?raw)
