Skip to content

Get All Employee Records

Request

Retrieves a list of employee records based on the provided authorization details.

Security
Bearer
curl -i -X GET \
  https://developer.sustainabilitymaster.ai/_mock/openapi/api/EnterpriseTables/EmployeeMaster \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved the employee records

Bodyapplication/json
Array [
idinteger, (int32)

The unique identifier for the employee

Example:101
empIdstring, non-emptyrequired

Employee Identification number

Example:"EMP001"
anonymiserIdstring or null

Anonymiser Identifier for the employee

Example:"ba998cd9-95fd-5e35-8586-0b9b898d01c0"
isEmployeebooleanrequired

Flag indicating if the individual is an internal employee

Example:true
genderIdinteger, (int32)required

Gender Identifier

Example:1
genderstring or null

Gender description (e.g., Male, Female)

Example:"Male"
companyIdinteger, (int32)required

Company identifier. Retrieve it from the Company GET API and use the ID value returned in the response.

Example:2
companystring or null

Company Name

Example:"Acme Corp"
countryIdinteger or null, (int32)

Country identifier. Retrieve it from the Country GET API and use the ID value returned in the response.

Example:1
countrystring or null

Country Name

Example:"India"
departmentIdinteger or null, (int32)

Department identifier. Retrieve it from the Department GET API and use the ID value returned in the response.

Example:10
departmentstring or null

Department Name

Example:"Human Resources"
businessUnitIdinteger or null, (int32)

Business unit identifier. Retrieve it from the BusinessUnit GET API and use the ID value returned in the response.

Example:5
businessUnitstring or null

Business Unit Name

Example:"Operations"
locationIdinteger or null, (int32)

Location identifier. Retrieve it from the Location GET API and use the ID value returned in the response.

Example:3
locationstring or null

Location Name

Example:"Bangalore"
dateOfBirthstring, (date-time)required

Date of Birth of the employee

Example:"1985-08-15"
dateOfJoiningstring, (date-time)required

Date the employee joined the company

Example:"2020-01-01"
dateOfReleasestring or null, (date-time)

Date the employee was released (left the company), if applicable

Example:null
employmentTypeIdinteger or null, (int32)

Employment type identifier (e.g., Full-time, Part-time)

Example:1
employmentTypestring or null

Employment type description

Example:"Permanent"
jobCategoryIdinteger or null, (int32)

Job category identifier

Example:2
jobCategorystring or null

Job category description

Example:"Full-Time"
memberOfGovernanceBodyboolean or null

Indicates whether the employee is a member of the governance body

Example:true
differentlyAbledboolean or null

Indicates whether the employee is differently-abled

Example:false
percentageFTEnumber or null, (double)

Represents the percentage of Full-Time Equivalent (FTE) for the employee. A value of 1.0 means full-time, while 0.5 means half-time. The value can also be null if the FTE percentage is not specified.

Example:0.5
]
Response
[
  {
    "id": 101,
    "empId": "EMP001",
    "anonymiserId": "ba998cd9-95fd-5e35-8586-0b9b898d01c0",
    "isEmployee": true,
    "genderId": 1,
    "gender": "Male",
    "companyId": 2,
    "company": "Acme Corp",
    "countryId": 1,
    "country": "India",
    "departmentId": 10,
    "department": "Human Resources",
    "businessUnitId": 5,
    "businessUnit": "Operations",
    "locationId": 3,
    "location": "Bangalore",
    "dateOfBirth": "1985-08-15",
    "dateOfJoining": "2020-01-01",
    "dateOfRelease": null,
    "employmentTypeId": 1,
    "employmentType": "Permanent",
    "jobCategoryId": 2,
    "jobCategory": "Full-Time",
    "memberOfGovernanceBody": true,
    "differentlyAbled": false,
    "percentageFTE": 0.5
  }
]