API Data Provider - Online Help

Employees

Returns the list of employees from the employee form.

Columns

Name Type ReadOnly References Description
EmployeeCode [KEY] String False

The unique employee identifier.

FirstName String False

The first name of the employee.

LastName String False

The last name of the employee.

Email String False

The email address of the employee.

DateOfBirth Date False

The date of birth of the employee.

Gender String False

The gender of the employee.

MaritalStatus String False

The marital status of the employee.

NickName String False

The nickname of the employee.

AboutMe String False

A brief description about the employee.

Mobile String False

The mobile phone number of the employee.

MobileCountryCode String True

The country code for the mobile phone number.

Extension String False

The phone extension of the employee.

WorkPhone String False

The work phone number of the employee.

OtherEmail String False

An alternate email address for the employee.

Department String False

The department the employee belongs to.

Designation String False

The designation or job title of the employee.

EmploymentType String False

The type of employment (e.g., Permanent, On Contract).

Role String False

The role assigned to the employee.

EmployeeStatus String True

The current status of the employee (e.g., Active, Inactive).

DateOfJoining Date False

The date the employee joined the organization.

DateOfExit Date False

The date the employee exited the organization.

Experience Integer True

The years of experience of the employee.

ExperienceDisplayValue String True

The experience displayed as a human-readable string (e.g., 10 year(s) 9 month(s)).

TotalExperience Integer True

The total experience of the employee in months.

TotalExperienceDisplayValue String True

The total experience displayed as a human-readable string (e.g., 19 year(s) 4 month(s)).

ReportingTo String False

The manager the employee reports to.

ReportingToId Long True

The ID of the manager the employee reports to.

ReportingToEmail String True

The email address of the manager the employee reports to.

LocationName String False

The name of the location assigned to the employee.

WorkLocation String False

The work location of the employee.

PresentAddress String False

The full present address of the employee as a single string.

PresentAddressLine1 String True

The first line of the employee's present address.

PresentAddressLine2 String True

The second line of the employee's present address.

PresentAddressCity String True

The city of the employee's present address.

PresentAddressState String True

The state of the employee's present address.

PresentAddressStateCode String True

The state code of the employee's present address (e.g., US-FL).

PresentAddressCountry String True

The country of the employee's present address.

PresentAddressCountryCode String True

The country code of the employee's present address (e.g., US).

PresentAddressPincode String True

The postal code of the employee's present address.

PermanentAddress String False

The permanent address of the employee.

PanNumber String False

The PAN (Permanent Account Number) of the employee.

UanNumber String False

The UAN (Universal Account Number) of the employee.

Tags String False

The tags associated with the employee.

SourceOfHire String False

The source through which the employee was hired (e.g., Direct).

Expertise String False

The area of expertise of the employee.

EducationDetails String False

The education details of the employee as a JSON array.

WorkExperience String False

The work experience of the employee as a JSON array.

DependentDetails String False

The dependent details of the employee as a JSON array.

ApprovalStatus String True

The approval status of the employee record.

ZohoId Long True

The internal Zoho numeric ID of the employee.

ZUID String True

The Zoho user ID of the employee.

DepartmentId Long True

Departments.ZohoID

The ID of the department the employee belongs to.

DesignationId Long True

Designations.ZohoID

The ID of the designation of the employee.

EmployeeTypeId Long True

The ID of the employment type of the employee.

RoleId Long True

The ID of the role assigned to the employee.

LocationNameId String True

The ID of the location assigned to the employee.

MaritalStatusId Long True

The ID of the marital status of the employee.

SourceOfHireId String True

The ID of the source of hire for the employee.

EmployeeStatusType Integer True

The numeric type of the employee status (0 = Inactive, 1 = Active).

Age Integer True

The age of the employee in years.

AgeDisplayValue String True

The age displayed as a human-readable string (e.g., 39 year(s) 5 month(s)).

Photo String True

The URL of the employee photo thumbnail.

PhotoDownloadUrl String True

The URL to download the employee photo.

AddedBy String True

The name of the user who added the employee record.

AddedById Long True

The ID of the user who added the employee record.

ModifiedBy String True

The name of the user who last modified the employee record.

ModifiedById Long True

The ID of the user who last modified the employee record.

ModifiedTime Datetime True

The Unix timestamp in milliseconds of when the employee record was last modified.

CreatedTime Datetime True

The Unix timestamp in milliseconds of when the employee record was created.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0