GET v1/employees

Gets a list of available active employees in the system

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of EmployeeSearchResult
NameDescriptionTypeAdditional information
Id

Read-only. Employee unique id - auto generated by the system.

integer

None.

Name

Complete Name of the Employee.

string

None.

Email

Primary Email address of the Employee.

string

None.

IsSystemUser

Identifies if the Employee is a Striven System User.

boolean

None.

DateCreated

Read-only. The date and time (in company time zone) when the employee was created.

date

None.

LastUpdatedDate

Read-only. The date and time (in company time zone) when the employee was last updated.

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "name": "sample string 2",
    "email": "sample string 3",
    "isSystemUser": true,
    "dateCreated": "2022-07-06T12:11:49.8542697-04:00",
    "lastUpdatedDate": "2022-07-06T12:11:49.8542697-04:00"
  },
  {
    "id": 1,
    "name": "sample string 2",
    "email": "sample string 3",
    "isSystemUser": true,
    "dateCreated": "2022-07-06T12:11:49.8542697-04:00",
    "lastUpdatedDate": "2022-07-06T12:11:49.8542697-04:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfEmployeeSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.HR">
  <EmployeeSearchResult>
    <DateCreated>2022-07-06T12:11:49.8542697-04:00</DateCreated>
    <Email>sample string 3</Email>
    <Id>1</Id>
    <IsSystemUser>true</IsSystemUser>
    <LastUpdatedDate>2022-07-06T12:11:49.8542697-04:00</LastUpdatedDate>
    <Name>sample string 2</Name>
  </EmployeeSearchResult>
  <EmployeeSearchResult>
    <DateCreated>2022-07-06T12:11:49.8542697-04:00</DateCreated>
    <Email>sample string 3</Email>
    <Id>1</Id>
    <IsSystemUser>true</IsSystemUser>
    <LastUpdatedDate>2022-07-06T12:11:49.8542697-04:00</LastUpdatedDate>
    <Name>sample string 2</Name>
  </EmployeeSearchResult>
</ArrayOfEmployeeSearchResult>