Retrieve a single employee by its employee id

GET 
/odata/v2/Employee/:key

Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.

Request

Path Parameters

key stringrequired

Query Parameters

$skip number

Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip

Responses

200

OK

application/json

Schema

Schema

employeeId stringnullable
nameFirstName stringnullable
nameMiddleName stringnullable
nameLastName stringnullable
nameFullName stringnullable
salutation int32
nickName stringnullable
addressStreet stringnullable
addressCity stringnullable
addressStateProvince stringnullable
addressZipPostalCode stringnullable
addressCountryRegion stringnullable
addressAddress stringnullable
socialSecurityNumber stringnullable
nationalityId stringnullable
languageId stringnullable
email stringnullable
url stringnullable
maritalStatus int32
gender int32
birthDate date-timenullable
seniorityDate date-timenullable
homePhoneNumberCountryName stringnullable
homePhoneNumberCityAreaCode stringnullable
homePhoneNumberLocalNumber stringnullable
homePhoneNumberExtension stringnullable
homePhoneNumberFullPhoneNumber stringnullable
workPhoneNumberCountryName stringnullable
workPhoneNumberCityAreaCode stringnullable
workPhoneNumberLocalNumber stringnullable
workPhoneNumberExtension stringnullable
workPhoneNumberFullPhoneNumber stringnullable
mobilePhoneNumberCountryName stringnullable
mobilePhoneNumberCityAreaCode stringnullable
mobilePhoneNumberLocalNumber stringnullable
mobilePhoneNumberExtension stringnullable
mobilePhoneNumberFullPhoneNumber stringnullable
userId stringnullable
active boolean
initials stringnullable
jubileeDate date-timenullable
privateEmail stringnullable
privateMobilePhoneNumberCountryName stringnullable
privateMobilePhoneNumberCityAreaCode stringnullable
privateMobilePhoneNumberLocalNumber stringnullable
privateMobilePhoneNumberExtension stringnullable
privateMobilePhoneNumberFullPhoneNumber stringnullable
accountNumber stringnullable
accountRegNumber stringnullable
longitude double
latitude double
externalReference stringnullable
rowNumber int32
createdBy stringnullable
createdDateTime date-time
modifiedBy stringnullable
modifiedDateTime date-timenullable
versionStamp int32
documentsExists boolean
preventAutoEnable boolean
preventAutoDisable boolean
activeUser boolean
languageCultureId stringnullable
carLicensePlate stringnullable
iban stringnullable
swift stringnullable
regionCultureId stringnullable
optionalUserId stringnullable
workTimeStartDate date-timenullable
workTimeEndDate date-timenullable

position

object

positionId stringnullable

employeeId stringnullable

title stringnullable

locationId stringnullable

organizationId stringnullable

employmentCategoryName stringnullable

dimension1Id stringnullable

dimension2Id stringnullable

dimension3Id stringnullable

dimension4Id stringnullable

externalReference stringnullable

employmentInformation

object

employeeId stringnullable

seniorityDate date-timenullable

hiredDate date-timenullable

terminatedDate date-timenullable

Example (from schema)

{
  "employeeId": "string",
  "nameFirstName": "string",
  "nameMiddleName": "string",
  "nameLastName": "string",
  "nameFullName": "string",
  "salutation": 0,
  "nickName": "string",
  "addressStreet": "string",
  "addressCity": "string",
  "addressStateProvince": "string",
  "addressZipPostalCode": "string",
  "addressCountryRegion": "string",
  "addressAddress": "string",
  "socialSecurityNumber": "string",
  "nationalityId": "string",
  "languageId": "string",
  "email": "string",
  "url": "string",
  "maritalStatus": 0,
  "gender": 0,
  "birthDate": "2026-03-25T15:10:38.631Z",
  "seniorityDate": "2026-03-25T15:10:38.631Z",
  "homePhoneNumberCountryName": "string",
  "homePhoneNumberCityAreaCode": "string",
  "homePhoneNumberLocalNumber": "string",
  "homePhoneNumberExtension": "string",
  "homePhoneNumberFullPhoneNumber": "string",
  "workPhoneNumberCountryName": "string",
  "workPhoneNumberCityAreaCode": "string",
  "workPhoneNumberLocalNumber": "string",
  "workPhoneNumberExtension": "string",
  "workPhoneNumberFullPhoneNumber": "string",
  "mobilePhoneNumberCountryName": "string",
  "mobilePhoneNumberCityAreaCode": "string",
  "mobilePhoneNumberLocalNumber": "string",
  "mobilePhoneNumberExtension": "string",
  "mobilePhoneNumberFullPhoneNumber": "string",
  "userId": "string",
  "active": true,
  "initials": "string",
  "jubileeDate": "2026-03-25T15:10:38.631Z",
  "privateEmail": "string",
  "privateMobilePhoneNumberCountryName": "string",
  "privateMobilePhoneNumberCityAreaCode": "string",
  "privateMobilePhoneNumberLocalNumber": "string",
  "privateMobilePhoneNumberExtension": "string",
  "privateMobilePhoneNumberFullPhoneNumber": "string",
  "accountNumber": "string",
  "accountRegNumber": "string",
  "longitude": 0,
  "latitude": 0,
  "externalReference": "string",
  "rowNumber": 0,
  "createdBy": "string",
  "createdDateTime": "2026-03-25T15:10:38.631Z",
  "modifiedBy": "string",
  "modifiedDateTime": "2026-03-25T15:10:38.631Z",
  "versionStamp": 0,
  "documentsExists": true,
  "preventAutoEnable": true,
  "preventAutoDisable": true,
  "activeUser": true,
  "languageCultureId": "string",
  "carLicensePlate": "string",
  "iban": "string",
  "swift": "string",
  "regionCultureId": "string",
  "optionalUserId": "string",
  "workTimeStartDate": "2026-03-25T15:10:38.631Z",
  "workTimeEndDate": "2026-03-25T15:10:38.631Z",
  "position": {
    "positionId": "string",
    "employeeId": "string",
    "title": "string",
    "locationId": "string",
    "organizationId": "string",
    "employmentCategoryName": "string",
    "dimension1Id": "string",
    "dimension2Id": "string",
    "dimension3Id": "string",
    "dimension4Id": "string",
    "externalReference": "string"
  },
  "employmentInformation": {
    "employeeId": "string",
    "seniorityDate": "2026-03-25T15:10:38.631Z",
    "hiredDate": "2026-03-25T15:10:38.631Z",
    "terminatedDate": "2026-03-25T15:10:38.631Z"
  }
}

400

Bad request. Occurs if the request payload or querystring contains invalid data

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

Unauthorized

Loading...