GET v1/employees/{id}

Gets employee details by id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Employee
NameDescriptionTypeAdditional information
Id

Employee Id

integer

None.

EmployeeNumber

Employee Number

string

None.

Prefix

Employee Prefix Name

string

None.

Firstname

Employee First Name

string

None.

MiddleName

Employee Middle Name

string

None.

Lastname

Employee Last Name

string

None.

Suffix

Employee Suffix Name

string

None.

Birthdate

Employee Birth Date

date

None.

StartDate

The date and time (in company time zone) when the employee was joined.

date

None.

SystemUser

Is the employee a system user?

boolean

None.

Status

true is active, false is inactive

boolean

None.

Phones

Employee Phone numbers. Preferred phone number is the primary phone.

Collection of Phone

None.

Emails

Employee Email List, primary email is marked.

Collection of EmailAddress

None.

Address

Employee Address

Address

None.

CustomFields

Collection of CustomField

None.

MeetingLink

Meeting Link

string

None.

MeetingJoiningInfo

Meeting Joining Information

string

None.

ScheduleAppointmentLink

Schedule Appointment Link

string

None.

ScheduleAppointmentLinkText

Schedule Appointment Link Text

string

None.

Manager

IdNamePair

None.

Location

IdNamePair

None.

JobTitle

IdNamePair

None.

Division

IdNamePair

None.

JobType

IdNamePair

None.

NonExemptEmployee

Non-Exempt Employee

boolean

None.

DateCreated

The date and time (in company time zone) when the employee was created

date

None.

CreatedBy

IdNamePair

None.

LastUpdatedDate

The date and time (in company time zone) when the employee was last updated

date

None.

LastUpdatedBy

IdNamePair

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "employeeNumber": "sample string 2",
  "prefix": "sample string 3",
  "firstname": "sample string 4",
  "middleName": "sample string 5",
  "lastname": "sample string 6",
  "suffix": "sample string 7",
  "birthdate": "2022-07-01T16:29:43.7136373-04:00",
  "startDate": "2022-07-01T16:29:43.7136373-04:00",
  "systemUser": true,
  "status": true,
  "phones": [
    {
      "id": 1,
      "phoneType": {
        "id": 1,
        "name": "sample string 2"
      },
      "countryDialCode": 2,
      "number": "sample string 3",
      "extension": "sample string 4",
      "isPreferred": true,
      "active": true
    },
    {
      "id": 1,
      "phoneType": {
        "id": 1,
        "name": "sample string 2"
      },
      "countryDialCode": 2,
      "number": "sample string 3",
      "extension": "sample string 4",
      "isPreferred": true,
      "active": true
    }
  ],
  "emails": [
    {
      "id": 1,
      "email": "sample string 2",
      "isPrimary": true,
      "active": true
    },
    {
      "id": 1,
      "email": "sample string 2",
      "isPrimary": true,
      "active": true
    }
  ],
  "address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "address3": "sample string 3",
    "city": "sample string 4",
    "state": "sample string 5",
    "postalCode": "sample string 6",
    "country": "sample string 7",
    "latitude": 8.0,
    "longitude": 9.0,
    "fullAddress": "sample string 10"
  },
  "customFields": [
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    }
  ],
  "meetingLink": "sample string 11",
  "meetingJoiningInfo": "sample string 12",
  "scheduleAppointmentLink": "sample string 13",
  "scheduleAppointmentLinkText": "sample string 14",
  "manager": {
    "id": 1,
    "name": "sample string 2"
  },
  "location": {
    "id": 1,
    "name": "sample string 2"
  },
  "jobTitle": {
    "id": 1,
    "name": "sample string 2"
  },
  "division": {
    "id": 1,
    "name": "sample string 2"
  },
  "jobType": {
    "id": 1,
    "name": "sample string 2"
  },
  "nonExemptEmployee": true,
  "dateCreated": "2022-07-01T16:29:43.7136373-04:00",
  "createdBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "lastUpdatedDate": "2022-07-01T16:29:43.7136373-04:00",
  "lastUpdatedBy": {
    "id": 1,
    "name": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<Employee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.HR">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:Address3>sample string 3</d2p1:Address3>
    <d2p1:City>sample string 4</d2p1:City>
    <d2p1:Country>sample string 7</d2p1:Country>
    <d2p1:FullAddress>sample string 10</d2p1:FullAddress>
    <d2p1:Latitude>8</d2p1:Latitude>
    <d2p1:Longitude>9</d2p1:Longitude>
    <d2p1:PostalCode>sample string 6</d2p1:PostalCode>
    <d2p1:State>sample string 5</d2p1:State>
  </Address>
  <Birthdate>2022-07-01T16:29:43.7136373-04:00</Birthdate>
  <CreatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </CreatedBy>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
  </CustomFields>
  <DateCreated>2022-07-01T16:29:43.7136373-04:00</DateCreated>
  <Division xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Division>
  <Emails xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:EmailAddress>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Email>sample string 2</d2p1:Email>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
    </d2p1:EmailAddress>
    <d2p1:EmailAddress>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Email>sample string 2</d2p1:Email>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
    </d2p1:EmailAddress>
  </Emails>
  <EmployeeNumber>sample string 2</EmployeeNumber>
  <Firstname>sample string 4</Firstname>
  <Id>1</Id>
  <JobTitle xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </JobTitle>
  <JobType xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </JobType>
  <LastUpdatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </LastUpdatedBy>
  <LastUpdatedDate>2022-07-01T16:29:43.7136373-04:00</LastUpdatedDate>
  <Lastname>sample string 6</Lastname>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Location>
  <Manager xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Manager>
  <MeetingJoiningInfo>sample string 12</MeetingJoiningInfo>
  <MeetingLink>sample string 11</MeetingLink>
  <MiddleName>sample string 5</MiddleName>
  <NonExemptEmployee>true</NonExemptEmployee>
  <Phones xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:Phone>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
      <d2p1:Extension>sample string 4</d2p1:Extension>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPreferred>true</d2p1:IsPreferred>
      <d2p1:Number>sample string 3</d2p1:Number>
      <d2p1:PhoneType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:PhoneType>
    </d2p1:Phone>
    <d2p1:Phone>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
      <d2p1:Extension>sample string 4</d2p1:Extension>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPreferred>true</d2p1:IsPreferred>
      <d2p1:Number>sample string 3</d2p1:Number>
      <d2p1:PhoneType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:PhoneType>
    </d2p1:Phone>
  </Phones>
  <Prefix>sample string 3</Prefix>
  <ScheduleAppointmentLink>sample string 13</ScheduleAppointmentLink>
  <ScheduleAppointmentLinkText>sample string 14</ScheduleAppointmentLinkText>
  <StartDate>2022-07-01T16:29:43.7136373-04:00</StartDate>
  <Status>true</Status>
  <Suffix>sample string 7</Suffix>
  <SystemUser>true</SystemUser>
</Employee>