Get Employees List - Gofive OpenAPI

ดึงรายชื่อพนักงาน

ดึงรายชื่อพนักงานของ tenant พร้อมข้อมูลที่เลือกได้เป็นส่วน ๆ ผ่าน fields — ไม่ระบุ fields จะได้เฉพาะข้อมูล
พื้นฐาน (ชื่อ-สกุล ชื่อเล่น วันที่เริ่มงาน) ซึ่งเร็วกว่ามาก

fields รับหลายค่าคั่นด้วย , — information (ข้อมูลส่วนตัว), workInfo (ข้อมูลการจ้างงานและหน่วยงาน),
address (ที่อยู่), family (ครอบครัว), education (การศึกษา), experience (ประสบการณ์),
customField (ฟิลด์กำหนดเอง) — ยิ่งขอมากยิ่งช้า ขอเท่าที่ใช้จริง

WorkingInformation.Organization รองรับหน่วยงานได้ถึง 20 ระดับ — Level7 ขึ้นไปจะปรากฏเฉพาะ tenant
ที่ตั้งโครงสร้างลึกกว่า 6 ระดับ ผู้เรียกที่อ่านแค่ Level1–Level6 จึงไม่ได้รับผลกระทบ

endpoint นี้เป็น เวอร์ชัน 2 (/api/v2/...) ตามที่ระบบให้บริการจริง

ไม่พบพนักงานตามตัวกรองจะได้ 204

ต้องมีสิทธิ์ Open API โมดูล Employee ระดับ Read

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

สำเร็จ — Data คือรายชื่อพนักงาน (ส่วนที่ไม่ได้ขอผ่าน fields จะเป็น null)

Bodyapplication/json

Examples

SuccessSuccess 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": "[email protected]",
                "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
        }
    ]
}

🟢204No Content

🟠401Unauthorized

🟠403Forbidden

🟠429

🔴500Server Error