Get Employees List

GET/empeo/api/v2/employees/lists

Request

Query Params

pageSize

number

required

Total number of record to be retrieved (Maximum 1000)

Example:

pageIndex

number

required

Start index of the record to be skipped

Example:

emailaddress

string

optional

Employee email address (both personal and organization)

Example:

[email protected]

fields

string

optional

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]

Example:

Address,Family

employeeRefId

string

optional

Unique identifier for referring to employees (Employee No.)

Example:

23003

Header Params

Content-Type

string

required

Accepted value: application/json

Example:

application/json

Ocp-Apim-Subscription-Key

string

required

Api subscription key get from the OpenAPI integration setting page

Example:

WPe123a9RKbcfLQNSztr45

Authorization

string

required

Authorization credential utilized in API requests

Example:

bearer {your token}

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

statusCode

integer

optional

message

string

optional

error

string

optional

totals

integer

optional

Total number of data returned

data

array [object {1}]

optional

Data object

employees

array [array]

optional

List of employees

{
  "statusCode": 200,
  "message": "OK",
  "totals": 1,
  "data": [
    {
      "employeeRefId": "63000",
      "firstName": "อมรพงศ์",
      "lastName": "จีรทวีกิจ",
      "firstNameEN": "Amornporn",
      "lastNameEN": "Jeerataveekij",
      "nickName": "พงษ์",
      "nickNameEN": "Pong",
      "dateHired": "2022-11-01T00:00:00",
      "contact": {
        "emailAddress": null,
        "mobileNo": "0909273114",
        "telephoneNo": "025466228"
      },
      "addresses": {
        "address": "30/88 Chetsadavithi Road",
        "subdistrict": "โคกขาม",
        "districtName": "เมืองสมุทรสาคร",
        "provinceName": "สมุทรสาคร",
        "postalCode": "74000"
      },
      "information": {
        "gender": "Female",
        "religion": "พุทธ",
        "national": "ไทย",
        "race": null,
        "bloodGroup": null,
        "height": 180,
        "weight": 71,
        "millitaryStatus": "ผ่านการเกณฑ์ทหารแล้ว",
        "maritalStatus": "หม้าย"
      },
      "family": [
        {
          "familyRefNo": 12530,
          "fullName": "ระไม้ ",
          "relationShip": "คู่สมรส",
          "nationality": null,
          "religion": null,
          "race": null,
          "dateOfBirth": "1951-06-01",
          "contact": null
        }
      ],
      "workExperiences": [
        {
          "experienceNo": 3,
          "workplace": "Goaway co, ltd.",
          "dateFrom": "2018-11-01T00:00:00",
          "dateTo": "2021-09-01T00:00:00",
          "position": "Super Manager",
          "jobDescription": "บริหารข้อมูลทางบริษัท",
          "salary": 70001,
          "resignationReason": null
        },
        {
          "experienceNo": 4,
          "workplace": "gofive",
          "dateFrom": "2017-06-01T00:00:00",
          "dateTo": "2018-07-01T00:00:00",
          "position": "Programmer",
          "jobDescription": "Developer",
          "salary": 24000,
          "resignationReason": null
        },
        {
          "experienceNo": 5,
          "workplace": "บริษัท ทดสอบ จำกัด",
          "dateFrom": "2021-02-01T00:00:00",
          "dateTo": "2021-12-01T00:00:00",
          "position": "Super Manager",
          "jobDescription": "test",
          "salary": 50000,
          "resignationReason": null
        }
      ],
      "educations": [
        {
          "educationRefNo": 10103,
          "institution": "มหาวิทยาลัยทดสอบ",
          "major": "โปรแกรมเมอร์",
          "degree": "ปริญญาตรี",
          "fromYear": 2022,
          "toYear": 2024
        },
        {
          "educationRefNo": 9141,
          "institution": "Gofive international collage",
          "major": "เทคโนโลยีสารสนเทศ",
          "degree": "มัธยมศึกษาตอนปลาย",
          "fromYear": 2011,
          "toYear": 2017
        },
        {
          "educationRefNo": 9125,
          "institution": "อนุบาลสินสาคร",
          "major": "วิทยาศาสตร์",
          "degree": "ประถมศึกษา",
          "fromYear": 1999,
          "toYear": 2011
        }
      ],
      "workingInformation": {
        "position": "CEO",
        "statusId": 2,
        "status": "บรรจุ",
        "typeId": 2175,
        "type": "รายวัน",
        "managerRefId": null,
        "emailAddress": "[email protected]",
        "imagePath": "https://api.myempeo.com/api/Service/GeneratePictureUrl/?path=Tenant/c0852922-c44b-4919-9ea7-540ef22fd4fa/PictureProfiles/Thumbnail/6413_1652352343001.jpeg",
        "workingLocation": null,
        "rank": "CEO",
        "organization": {
          "level1": "วีนีโอ้ซีอาร์เอ็ม จำกัด",
          "level2": "บุคคล",
          "level3": null,
          "level4": null,
          "level5": null,
          "level6": null
        }
      },
      "customField": [
        {
          "fieldName": "Single Selection",
          "value": "Option 1"
        },
        {
          "fieldName": "Multi Selection",
          "value": "Option 1,Option 3"
        },
        {
          "fieldName": "Drop down List",
          "value": "Option 1"
        },
        {
          "fieldName": "Date Picker",
          "value": "2023-11-02"
        },
        {
          "fieldName": "Paragraph",
          "value": "asdfasdfasdfawsfewafawe fawe fawe fawe f"
        },
        {
          "fieldName": "Text - none",
          "value": ""
        },
        {
          "fieldName": "Text - Letter",
          "value": "TextLetter"
        },
        {
          "fieldName": "Text - Number",
          "value": ""
        },
        {
          "fieldName": "Text - Email",
          "value": ""
        },
        {
          "fieldName": "Text - Custom",
          "value": "a"
        }
      ]
    }
  ]
}

Last modified: a year ago