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

Example

{
    "StatusCode": 200,
    "Message": "OK",
    "Totals": 1,
    "Data": [
        {
            "EmployeeRefId": "EMP001",
            "FirstName": "พนักงานตัวอย่าง",
            "LastName": "หนึ่ง",
            "FirstNameEN": "Sample",
            "LastNameEN": "One",
            "NickName": "ตัวอย่าง",
            "NickNameEN": "Sample",
            "TitleName": "นาย",
            "TitleNameEN": "Mr.",
            "DateHired": "2024-01-15T00:00:00",
            "Contact": {
                "EmailAddress": "[email protected]",
                "MobileNo": "0800000001",
                "TelephoneNo": null
            },
            "Information": null,
            "Addresses": null,
            "Family": null,
            "Educations": null,
            "WorkExperiences": null,
            "CustomFields": null,
            "WorkingInformation": {
                "Position": "นักพัฒนาระบบ",
                "StatusId": 1,
                "Status": "พนักงานประจำ",
                "Organization": {
                    "Level1": "บริษัทตัวอย่าง",
                    "Level2": "สำนักงานใหญ่",
                    "Level3": "ฝ่ายตัวอย่าง",
                    "Level4": null,
                    "Level5": null,
                    "Level6": null
                }
            }
        }
    ]
}

🟢204No Content

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

🔴500Server Error