employee

Get Many Employees

Get Many Employees

Securitybearer
Request
query Parameters
select
Array of strings

Select Employee fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "title" "active" "companyId" "officeId" "managerEmployeeId" "departmentId" "costCenterId" "effectiveCostCenterId" "employmentId" "employmentTypeId" "employmentCountry" "compensationId" "userId" "userName" "division" "organization" "organizationId" "employeeNumber" "workEmail" "workPhone" "workPhoneSanitized" "hireDate" "endDate" "hasOccupationalPension" "privateEmail" "firstName" "lastName" "ssn" "ssnCountry" "privatePhone" "privatePhoneSanitized" "birthDate" "age" "nationality" "gender" "pronoun" "created" "updated" "offboardDate"
relations
Array of strings

Select related Employee resources, comma-separated. (e.g. relations=office,department)

Items Enum: "office" "costCenter" "effectiveCostCenter" "child" "department" "emergencyContact" "employment" "employmentType" "compensation" "managerEmployee" "teamReference"
object

Filters conditions per field. (e.g. filters[id][$eq]=507f1f77bcf86cd799439011)

limit
integer

Limit amount of received Employees. (e.g. limit=20)

offset
integer

Offset amount of received Employees. (e.g. offset=20)

object

Sort received Employees by field. (e.g. sort[id]=asc)

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/employee
Response samples
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": {
    }
}

Create One Employee

Create One Employee

Securitybearer
Request
Request Body schema: application/json
required
title
string
officeId
string
managerEmployeeId
string
departmentId
string
costCenterId
string
userName
string
division
string
organization
string
organizationId
string
employeeNumber
string
object (EmployeeTaxRequest)
workEmail
string
workPhone
string
hasOccupationalPension
boolean
privateEmail
string
firstName
string
lastName
string
ssn
string
ssnCountry
string
Enum: "SE" "NO" "DK" "FI" "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CY" "CZ" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "XK" "RE" "RO" "RU" "RW" "SH" "KN" "LC" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "CS" "SC" "SL" "SG" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SR" "SJ" "SZ" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
privatePhone
string
birthDate
string
avatarUrl
string
nationality
string
gender
string
pronoun
string
object (BankAccountRequest)
object (HomeAddressRequest)
custom
object
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/employee
Request samples
application/json
{
  • "title": "string",
  • "officeId": "507f1f77bcf86cd799439011",
  • "managerEmployeeId": "507f1f77bcf86cd799439011",
  • "departmentId": "507f1f77bcf86cd799439011",
  • "costCenterId": "507f1f77bcf86cd799439011",
  • "userName": "john.doe@example.com",
  • "division": "Division 1",
  • "organization": "Organization 1",
  • "organizationId": "507f1f77bcf86cd799439011",
  • "employeeNumber": 1,
  • "tax": {
    },
  • "workEmail": "string",
  • "workPhone": "string",
  • "hasOccupationalPension": true,
  • "privateEmail": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "ssn": "string",
  • "ssnCountry": "SE",
  • "privatePhone": "string",
  • "birthDate": "string",
  • "avatarUrl": "string",
  • "nationality": "string",
  • "gender": "string",
  • "pronoun": "string",
  • "bankAccount": {
    },
  • "homeAddress": {
    },
  • "custom": {
    }
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Employee

Get One Employee

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

Select Employee fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "title" "active" "companyId" "officeId" "managerEmployeeId" "departmentId" "costCenterId" "effectiveCostCenterId" "employmentId" "employmentTypeId" "employmentCountry" "compensationId" "userId" "userName" "division" "organization" "organizationId" "employeeNumber" "workEmail" "workPhone" "workPhoneSanitized" "hireDate" "endDate" "hasOccupationalPension" "privateEmail" "firstName" "lastName" "ssn" "ssnCountry" "privatePhone" "privatePhoneSanitized" "birthDate" "age" "nationality" "gender" "pronoun" "created" "updated" "offboardDate"
relations
Array of strings

Select related Employee resources, comma-separated. (e.g. relations=office,department)

Items Enum: "office" "costCenter" "effectiveCostCenter" "child" "department" "emergencyContact" "employment" "employmentType" "compensation" "managerEmployee" "teamReference"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/employee/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": {
    }
}

Update One Employee

Update One Employee

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
title
string
officeId
string
managerEmployeeId
string
departmentId
string
costCenterId
string
userName
string
division
string
organization
string
organizationId
string
employeeNumber
string
object (EmployeeTaxRequest)
workEmail
string
workPhone
string
hasOccupationalPension
boolean
privateEmail
string
firstName
string
lastName
string
ssn
string
ssnCountry
string
Enum: "SE" "NO" "DK" "FI" "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CY" "CZ" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "XK" "RE" "RO" "RU" "RW" "SH" "KN" "LC" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "CS" "SC" "SL" "SG" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SR" "SJ" "SZ" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
privatePhone
string
birthDate
string
avatarUrl
string
nationality
string
gender
string
pronoun
string
object (BankAccountRequest)
object (HomeAddressRequest)
custom
object
active
boolean
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/employee/{id}
Request samples
application/json
{
  • "title": "string",
  • "officeId": "507f1f77bcf86cd799439011",
  • "managerEmployeeId": "507f1f77bcf86cd799439011",
  • "departmentId": "507f1f77bcf86cd799439011",
  • "costCenterId": "507f1f77bcf86cd799439011",
  • "userName": "john.doe@example.com",
  • "division": "Division 1",
  • "organization": "Organization 1",
  • "organizationId": "507f1f77bcf86cd799439011",
  • "employeeNumber": 1,
  • "tax": {
    },
  • "workEmail": "string",
  • "workPhone": "string",
  • "hasOccupationalPension": true,
  • "privateEmail": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "ssn": "string",
  • "ssnCountry": "SE",
  • "privatePhone": "string",
  • "birthDate": "string",
  • "avatarUrl": "string",
  • "nationality": "string",
  • "gender": "string",
  • "pronoun": "string",
  • "bankAccount": {
    },
  • "homeAddress": {
    },
  • "custom": {
    },
  • "active": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Employee

Replace One Employee

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
title
string
officeId
string
managerEmployeeId
string
departmentId
string
costCenterId
string
userName
string
division
string
organization
string
organizationId
string
employeeNumber
string
object (EmployeeTaxRequest)
workEmail
string
workPhone
string
hasOccupationalPension
boolean
privateEmail
string
firstName
string
lastName
string
ssn
string
ssnCountry
string
Enum: "SE" "NO" "DK" "FI" "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CY" "CZ" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "XK" "RE" "RO" "RU" "RW" "SH" "KN" "LC" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "CS" "SC" "SL" "SG" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SR" "SJ" "SZ" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
privatePhone
string
birthDate
string
avatarUrl
string
nationality
string
gender
string
pronoun
string
object (BankAccountRequest)
object (HomeAddressRequest)
custom
object
active
boolean
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/employee/{id}
Request samples
application/json
{
  • "title": "string",
  • "officeId": "507f1f77bcf86cd799439011",
  • "managerEmployeeId": "507f1f77bcf86cd799439011",
  • "departmentId": "507f1f77bcf86cd799439011",
  • "costCenterId": "507f1f77bcf86cd799439011",
  • "userName": "john.doe@example.com",
  • "division": "Division 1",
  • "organization": "Organization 1",
  • "organizationId": "507f1f77bcf86cd799439011",
  • "employeeNumber": 1,
  • "tax": {
    },
  • "workEmail": "string",
  • "workPhone": "string",
  • "hasOccupationalPension": true,
  • "privateEmail": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "ssn": "string",
  • "ssnCountry": "SE",
  • "privatePhone": "string",
  • "birthDate": "string",
  • "avatarUrl": "string",
  • "nationality": "string",
  • "gender": "string",
  • "pronoun": "string",
  • "bankAccount": {
    },
  • "homeAddress": {
    },
  • "custom": {
    },
  • "active": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Employee

Delete One Employee

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Responses
204
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

delete/employee/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to department