GET
/api/public/v1/employee-onboardings/{employeeId}

Get an onboarding employee

Retrieve a single onboarding record for an employee.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

employee:onboardings:read

Path Parameters

NameTypeRequiredDescription
employeeIdstringRequiredEmployee ID.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/employee-onboardings/{employeeId}" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Employee retrieved successfully!",
  "content": {
    "employee": {
      "id": "emp_456",
      "onboardingStep": 2
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Employees → Onboardings
/employee/onboardings
  1. Open an onboarding from the table.