Sign in

v2

latestOpenAPI 3.1.0Proprietary - Licensed to Authorized Customers Only2026-07-31611061.1 MB
Employee

Create a new Employee

Create a new Employee

post/employee

Request body

gender'Female' | 'Male' | 'Other'

The gender of the person

identityNumberstring required

The identity number of the employee in the format YYYYMMDD-NNNN, must be unique within the organization.

identityTemporaryboolean

If the identity number is temporary for the employee

firstNamestring required

The first name of the employee

lastNamestring required

The last name of the employee

dateOfBirthstring date nullable

The date of birth of the employee

emailAddress1string nullable

The primary email address of the employee, will be used for communication with the employee from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization.

emailAddress2string nullable

The secondary email address of the employee, will not be used within the system, but will be displayed for contact information.

phoneNumber1string nullable

The primary phone number of the employee, will be used for communication with the employee from the system and must be unique within the organization.

phoneNumber2string nullable

The secondary phone number of the employee, will not be used within the system, but will be displayed for contact information.

eduPersonPrincipalNamestring nullable

The eduPersonPrincipalName (EPPN) of the employee, as defined in the SS12000:2020 standard (TK450). A globally unique, persistent identifier used to identify users across Swedish e-services (e-tjänster). Format: localIdentifier@domain — e.g. kalko@edu.goteborg.se

Example request

{
  "external": {
    "sourceID": "12345678"
  },
  "identityNumber": "20191216-1234",
  "identityTemporary": true,
  "firstName": "Lise",
  "lastName": "Meitner",
  "dateOfBirth": "2019-12-16",
  "address": {
    "postalAddress": "Dalvägen 14",
    "postalCode": "169 56",
    "postalCity": "Solna",
    "countryCode": "SWE",
    "municipalityCode": "0184"
  },
  "emailAddress1": "lise@meitner.se",
  "emailAddress2": "lise@gmail.com",
  "phoneNumber1": "+46701234567",
  "phoneNumber2": "+46701234567",
  "eduPersonPrincipalName": "kalko@edu.goteborg.se"
}

Response

Response for Employee Create operation - returns the created Employee

idstring uuid required

Unique identifier for the Employee

gender'Female' | 'Male' | 'Other'

The gender of the person

identityNumberstring required

The identity number of the employee in the format YYYYMMDD-NNNN, must be unique within the organization.

identityTemporaryboolean

If the identity number is temporary for the employee

firstNamestring required

The first name of the employee

lastNamestring required

The last name of the employee

dateOfBirthstring date nullable

The date of birth of the employee

emailAddress1string nullable

The primary email address of the employee, will be used for communication with the employee from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization.

emailAddress2string nullable

The secondary email address of the employee, will not be used within the system, but will be displayed for contact information.

phoneNumber1string nullable

The primary phone number of the employee, will be used for communication with the employee from the system and must be unique within the organization.

phoneNumber2string nullable

The secondary phone number of the employee, will not be used within the system, but will be displayed for contact information.

eduPersonPrincipalNamestring nullable

The eduPersonPrincipalName (EPPN) of the employee, as defined in the SS12000:2020 standard (TK450). A globally unique, persistent identifier used to identify users across Swedish e-services (e-tjänster). Format: localIdentifier@domain — e.g. kalko@edu.goteborg.se

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
    "updatedAt": "2024-01-15T14:45:00Z",
    "updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
  },
  "external": {
    "sourceID": "12345678",
    "source": "ExternalIntegrationAPI"
  },
  "identityNumber": "20191216-1234",
  "identityTemporary": true,
  "firstName": "Lise",
  "lastName": "Meitner",
  "dateOfBirth": "2019-12-16",
  "address": {
    "postalAddress": "Dalvägen 14",
    "postalCode": "169 56",
    "postalCity": "Solna",
    "countryCode": "SWE",
    "municipalityCode": "0184"
  },
  "emailAddress1": "lise@meitner.se",
  "emailAddress2": "lise@gmail.com",
  "phoneNumber1": "+46701234567",
  "phoneNumber2": "+46701234567",
  "eduPersonPrincipalName": "kalko@edu.goteborg.se"
}