Create employee

Creates a new employee in the workspace with automatic user account creation and team assignments.

How employee creation works:

1. A new employee record is created with the provided information
2. If canLogin is true, a user account is automatically created:
   • User status is set to Active
   • In ready workspaces, an invitation email is sent to the employee
   • During initial workspace setup, invitation email delivery is deferred until setup is finished
   • The user is assigned the specified role
3. If an existing HelpdeskUser with the same email exists, it will be upgraded to Employee type
4. Teams are assigned if provided in the teams array
5. Employee data is automatically synced with the user account

Required fields:

• firstName: Employee first name
• lastName: Employee last name
• email: Unique email address (must not exist in the workspace)
• roleId: Role ID to assign to the user account

Optional fields:

• position: Job title/position
• canLogin: Whether employee can login (default: false)
• teams: Array of team IDs to assign the employee to
• avatarId: File ID from POST /workspace/upload endpoint

Custom fields: Employees do not support custom fields through this API.

Avatar upload process:

1. First, upload the avatar file using POST /workspace/upload
2. Get the file ID from the upload response
3. Use that file ID in the avatarId field when creating the employee

Note: The email address must be unique within the workspace. If canLogin is false, no user account is created initially, but one can be created later by updating the employee. To list or verify employees after creation, use GET /employees/grid if you have Employees.manage permission, or GET /workspace/users for the user list. There is no GET /employees list endpoint.

curl -X POST "https://leadtime.app/api/public/employees" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "avatarConfig": {
    "options": {
      "seed": "Jane Doe"
    },
    "style": "initials"
  },
  "avatarId": "123e4567-e89b-12d3-a456-426614174000",
  "canLogin": false,
  "email": "john.doe@company.com",
  "employmentMode": "PartTime",
  "firstName": "John",
  "lastName": "Doe",
  "position": "Software Engineer",
  "roleId": "ws_abc_role_123",
  "teams": [
    "team_1",
    "team_2"
  ]
}'

const response = await fetch("https://leadtime.app/api/public/employees", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "avatarConfig": {
    "options": {
      "seed": "Jane Doe"
    },
    "style": "initials"
  },
  "avatarId": "123e4567-e89b-12d3-a456-426614174000",
  "canLogin": false,
  "email": "john.doe@company.com",
  "employmentMode": "PartTime",
  "firstName": "John",
  "lastName": "Doe",
  "position": "Software Engineer",
  "roleId": "ws_abc_role_123",
  "teams": [
    "team_1",
    "team_2"
  ]
})
});

import requests

response = requests.post(
    "https://leadtime.app/api/public/employees",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "avatarConfig": {
    "options": {
      "seed": "Jane Doe"
    },
    "style": "initials"
  },
  "avatarId": "123e4567-e89b-12d3-a456-426614174000",
  "canLogin": False,
  "email": "john.doe@company.com",
  "employmentMode": "PartTime",
  "firstName": "John",
  "lastName": "Doe",
  "position": "Software Engineer",
  "roleId": "ws_abc_role_123",
  "teams": [
    "team_1",
    "team_2"
  ]
},
)

{
  "addressCity": "Berlin",
  "addressCountry": "DE",
  "addressHouseNumber": "42",
  "addressStreet": "Main Street",
  "addressZip": "12345",
  "avatarId": "123e4567-e89b-12d3-a456-426614174000",
  "avatarUrl": "https://workc.example.com/api/avatars/public/avatar_123.svg",
  "birthDate": "1990-01-15",
  "canLogin": true,
  "chargeableHoursDayGoal": 6.5,
  "createdAt": "2020-01-15T10:00:00Z",
  "degree": "M.Sc.",
  "email": "john.doe@company.com",
  "employmentMode": "FullTime",
  "entryDate": "2020-01-15",
  "exitDate": null,
  "firstName": "John",
  "id": "emp_123",
  "incomeTaxClass": "1",
  "isActive": true,
  "lastName": "Doe",
  "phone": "+1234567890",
  "position": "Software Engineer",
  "roleId": "ws_abc_role_123",
  "salaries": [
    {
      "dateFrom": "2021-01-01",
      "id": "sal_123",
      "salary": 5000
    }
  ],
  "teamIds": [
    "team_1",
    "team_2"
  ],
  "title": "Mr.",
  "updatedAt": "2020-01-15T10:00:00Z",
  "userId": "user_123",
  "vacationDays": [
    {
      "dateFrom": "2021-01-01",
      "days": 30,
      "id": "vac_123"
    }
  ],
  "weeklyWorkingTime": [
    {
      "dateFrom": "2021-01-01",
      "id": "wwt_123",
      "weeklyWorkingHours": 40,
      "workingDays": [
        1,
        1,
        1,
        1,
        1,
        0,
        0
      ]
    }
  ]
}

{
  "errors": {
    "email": [
      "Email is required",
      "Email must be valid"
    ],
    "firstName": [
      "First name is required"
    ],
    "lastName": [
      "Last name is required"
    ],
    "roleId": [
      "Role ID is required"
    ]
  },
  "message": "Bad Request",
  "statusCode": 400
}