Appearance
Employees
All requests use an integration bearer token. Successful reads return HTTP 200. Missing or inaccessible employee IDs return 404.
List employees
GET /api/v1/employees
Query parameters: page, pageSize, includeArchived, includePrivileged; see pagination and filtering.
bash
curl -H 'Authorization: Bearer YOUR_INTEGRATION_TOKEN' \
'https://YOUR-INSTANCE/api/v1/employees?page=1&pageSize=50'Returns { data: Employee[], pagination }. Each employee contains employeeId, name, email, position, hiringDate, employmentNumber, manager (display name or null), team (name or null), groups (names), onboardingStatus, workflows, and learningPaths. Optional fields permitted by the token appear with their snake_case allowlist names.
Employee overview
GET /api/v1/employees/{employeeId}
bash
curl -H 'Authorization: Bearer YOUR_INTEGRATION_TOKEN' \
'https://YOUR-INSTANCE/api/v1/employees/EMPLOYEE_ID'Returns { employee, workflows, learningPaths, summary }. workflows is an array of assignment IDs; summary contains workflowCount and learningPathCount. The employee overview uses camelCase profile fields, including personalEmail, preferredName, bloodType, dietaryRestrictions, and emergencyContact when allowed. Query the assigned workflow and learning path endpoints for full assignment details.
Optional profile fields
Set fieldAllowlist when creating a token. Supported names:
personal_email, address, phone, nationality, country, gender, age, preferred_name, blood_type, dietary_restrictions, emergency_contact.
Unknown names are ignored. These fields are omitted by default; a present nullable field may still be null. Avoid assuming list and overview objects have identical property names.