Get employees.
get
/connectedWorker/clientapi/v2/employees
This operation retrieves details of employees and can be performed by users with the IoTCWSupervisor role or higher.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Employees were successfully retrieved.
Nested Schema : Employee
Type:
Show Source
object
-
activeOrganizationId(optional):
string
Read Only:
true
Id of an organization where employee has active project assignmentExample:50
-
activeProjectId(optional):
string
Read Only:
true
Id of a project where employee is currently checked-inExample:51
-
deletedTime(optional):
string(date-time)
Read Only:
true
Date and time the employee wes deleted from IDCS. This field occurs only if not null. -
email:
string
Minimum Length:
5
Maximum Length:100
Email of employeeExample:john@smith.org
-
firstName:
string
Minimum Length:
0
Maximum Length:100
First name of employee, cannot be blankExample:John
-
id(optional):
string
Read Only:
true
The gid of the employeeExample:1234
-
idcsStatus(optional):
string
Read Only:
true
Status of the employee in IDCSExample:ACTIVE
-
lastName:
string
Minimum Length:
0
Maximum Length:100
Last name of employee, cannot be blankExample:Smith
-
links(optional):
array links
-
role:
string
Allowed Values:
[ "PROJECT_MANAGER", "SUPERVISOR", "WORKER" ]
-
timeZone(optional):
string
Read Only:
true
Time zone where employee is currently inExample:Europe/Paris
-
upCWRegisteredEmployee(optional):
object Employee
-
upIDCSFields(optional):
object IDCSIoTUser
-
username:
string
Minimum Length:
3
Maximum Length:100
Username of employee, cannot be blankExample:jsmith
-
workShiftId(optional):
string
Read Only:
true
Id of a work shift that employee is currently working onExample:52
Nested Schema : IDCSIoTUser
Type:
Show Source
object
-
emailAddresses(optional):
array emailAddresses
Unique Items Required:
true
-
firstName(optional):
string
-
id(optional):
string
-
internalUser(optional):
boolean
-
lastName(optional):
string
-
name(optional):
string
-
phoneNumbers(optional):
array phoneNumbers
Unique Items Required:
true
-
roles(optional):
array roles
Unique Items Required:
true
Nested Schema : Link
Type:
Show Source
object
-
href:
string
The target resource's URI
-
rel:
string
Relation type
Nested Schema : IDCSIoTUserEmail
Type:
Show Source
object
-
primary(optional):
boolean
-
type(optional):
string
Allowed Values:
[ "WORK", "HOME", "RECOVERY", "OTHER" ]
-
value(optional):
string
-
verified(optional):
boolean
Nested Schema : IDCSIoTUserPhone
Type:
Show Source
object
-
primary(optional):
boolean
-
type(optional):
string
Allowed Values:
[ "WORK", "HOME", "RECOVERY", "OTHER", "MOBILE", "FAX", "PAGER" ]
-
value(optional):
string
-
verified(optional):
boolean