# Get Employees List ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /empeo/api/v2/employees/lists: get: summary: 'Get Employees List ' deprecated: false description: '' tags: - empeo/Core HR/Employee parameters: - name: pageSize in: query description: Total number of record to be retrieved (Maximum 1000) required: true example: 10 schema: type: number - name: pageIndex in: query description: Start index of the record to be skipped required: true example: 0 schema: type: number - name: emailaddress in: query description: Employee email address (both personal and organization) required: false example: soraya.s120998@gmail.com schema: type: string - name: fields in: query description: >- Specified field will return data, If none will return default employee data. Fields that can query : [All, Contact, WorkInfo, Information, Education, Address, Experience, Family,CustomField] required: false example: information,workInfo,address,family schema: type: string - name: employeeRefId in: query description: Unique identifier for referring to employees (Employee No.) required: false example: '24008' schema: type: string - name: Content-Type in: header description: 'Accepted value: application/json' required: true example: application/json schema: type: string - name: Ocp-Apim-Subscription-Key in: header description: Api subscription key get from the OpenAPI integration setting page required: true example: WPe123a9RKbcfLQNSztr45 schema: type: string - name: Authorization in: header description: Authorization credential utilized in API requests required: true example: bearer {your token} schema: type: string responses: '200': description: '' content: application/json: schema: type: object properties: statusCode: type: integer message: type: string error: type: string data: type: array items: type: object properties: employees: type: array items: type: array items: type: object properties: employeeRefId: type: string description: >- Unique identifier for referring to employees (Employee No.) firstName: type: string description: First name of the employee lastName: type: string description: Last name of the employee firstNameEN: type: string description: First name of the employee (in English) lastNameEN: type: string description: Last name of the employee (in English) nickName: type: string description: Nickname of the employee nickNameEN: type: string description: Nickname of the employee (in English) dateHired: type: string description: Employee hired date contact: type: object properties: emailAddress: type: string description: Email address of the employee (Personal) telephoneNo: type: string description: >- Contact number of the employee (personal) x-apidog-orders: - emailAddress - telephoneNo description: Employee Contact workingInformation: type: object properties: position: type: string description: >- Job title held by the employee at the current company status: type: integer description: Employee work status type: type: string description: Employee employment type emailAddress: type: string description: >- Email address of the employee (in organization) telephoneNo: type: string description: >- Contact number of the employee (in organization) imagePath: type: string description: Employee profile picture URL organization: type: object properties: level1: type: string description: Organization Level 1 level2: type: string description: Organization Level 2 level3: type: string description: Organization Level 3 level4: type: string description: Organization Level 4 level5: type: string description: Organization Level 5 level6: type: string description: Organization Level 6 x-apidog-orders: - level1 - level2 - level3 - level4 - level5 - level6 description: >- The entity or company where the employee is currently employed ManagerRefId: type: string description: Supervisor employee No. of the employee x-apidog-orders: - position - status - type - ManagerRefId - emailAddress - telephoneNo - imagePath - organization description: Employment Details information: type: object properties: gender: type: string description: Gender national: type: string description: Employee nationality identificationNo: type: string description: >- The unique identification number associated with an employee identification card or document height: type: integer description: Employee height weight: type: integer description: Employee weight militaryStatus: type: string description: Military status of the employee maritalStatus: type: string description: Marital status of the employee religion: type: string description: Employee religion x-apidog-orders: - gender - religion - national - identificationNo - height - weight - militaryStatus - maritalStatus description: Employee information educations: type: array items: type: object properties: institution: type: string description: >- The educational institution attended by the employee for their studies major: type: string description: >- The primary field of study or specialization that the employee focused on during their education degree: type: string description: >- The academic degree or qualification obtained by the employee upon completing their education fromYear: type: integer description: >- The starting year when the employee began their studies at the educational institution toYear: type: integer description: >- The ending year when the employee completed or is expected to complete their studies at the educational institution educationRefNo: type: integer description: >- Employee education reference number (for update) x-apidog-orders: - educationRefNo - institution - major - degree - fromYear - toYear description: >- The educational background and qualifications of the employee, including degrees and relevant educational institutions attended workExperiences: type: array items: type: object properties: dateFrom: type: string description: >- The starting date of the employee's work experience at a past company (format : YYYY-MM-DD) dateTo: type: string description: >- The ending date of the employee's work experience at a past company (format : YYYY-MM-DD) position: type: string description: >- Job title held by the employee at a past company jobDescription: type: string description: >- A summary or outline of the responsibilities associated with the employee position or role salary: type: integer description: Employee past salary resignationReason: type: string description: >- The specific reason or explanation for resigning from position workplace: type: string description: >- Name of the company or place that employee used to worked in experienceNo: type: integer description: sequence of work experiences x-apidog-orders: - workplace - experienceNo - dateFrom - dateTo - position - jobDescription - salary - resignationReason description: Employee previous employment history addresses: type: object properties: address: type: string description: Address of the employee subdistrict: type: string description: Employee subdistrict districtName: type: string description: Employee district provinceName: type: string description: Employee province postalCode: type: string description: Postal code x-apidog-orders: - address - subdistrict - districtName - provinceName - postalCode description: Employee Address family: type: array items: type: object properties: fullName: type: string description: Full name of family member dateOfBirth: type: string description: >- Family date of birth (format : YYYY-MM-DD) contact: type: string description: Contact number of the employee. religion: type: string description: Family member religion familyRefNo: type: integer description: >- Employee family reference number (for update) relationship: type: string description: Relation with the employee x-apidog-orders: - familyRefNo - fullName - relationship - religion - dateOfBirth - contact description: Family members of the employee x-apidog-orders: - employeeRefId - firstName - lastName - firstNameEN - lastNameEN - nickName - nickNameEN - dateHired - contact - workingInformation - information - educations - workExperiences - addresses - family description: Employee details description: List of employees x-apidog-orders: - employees description: Data object totals: type: integer description: Total number of data returned x-apidog-orders: - statusCode - message - error - totals - data example: statusCode: 200 message: OK totals: 1 data: - employeeRefId: '24008' firstName: แอดมิน lastName: โกไฟว์ firstNameEN: Admin lastNameEN: Go5 nickName: null nickNameEN: null titleName: นาย titleNameEN: Mr. dateHired: '2024-01-09T00:00:00' contact: null addresses: address: null subdistrict: null districtName: null provinceName: null postalCode: null information: gender: Male religion: null national: null race: null bloodGroup: null identificationNo: '3219161128964' height: 0 weight: 0 millitaryStatus: null maritalStatus: null dateOfBirth: '2024-01-10T00:00:00' family: null workExperiences: null educations: null workingInformation: position: รองกรรมการผู้จัดการ statusId: 2 status: บรรจุ typeId: 102706 type: ประจำ managerRefId: '23459' emailAddress: soraya.s120998+00012@gmail.com imagePath: >- https://api-uat.empeo.com/api/Service/GeneratePictureUrl/?userId=31606 workingLocation: สำนักงานใหญ่ rank: Executive dateTermination: null organization: level1: บริษัทรักโกไฟว์ level2: เทคโนโลยีสารสนเทศ level3: null level4: null level5: null level6: null customFields: null headers: {} x-apidog-name: Success security: - bearerAuth: [] x-apidog: schemeGroups: - id: uyL_cJmK7q60QJZRTi5ot schemeIds: - bearerAuth required: true use: id: uyL_cJmK7q60QJZRTi5ot scopes: uyL_cJmK7q60QJZRTi5ot: bearerAuth: [] x-apidog-folder: empeo/Core HR/Employee x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/351895/apis/api-3845671-run components: schemas: {} securitySchemes: bearerAuth: type: jwt scheme: bearer bearerFormat: JWT description: ใส่ JWT Token ในรูปแบบ Bearer {token} bearer: type: bearer scheme: bearer servers: - url: https://api.gofive.co.th description: Production security: - bearerAuth: [] x-apidog: schemeGroups: - id: uyL_cJmK7q60QJZRTi5ot schemeIds: - bearerAuth required: true use: id: uyL_cJmK7q60QJZRTi5ot scopes: uyL_cJmK7q60QJZRTi5ot: bearerAuth: [] ```