Get Employees List - Gofive OpenAPI

Request

Query Params

pageSize

number

required

Total number of record to be retrieved (Maximum 1000)

Example:

10

pageIndex

number

required

Start index of the record to be skipped

Example:

0

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:

information,workInfo,address,family

employeeRefId

string

optional

Unique identifier for referring to employees (Employee No.)

Example:

24008

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

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.gofive.co.th/empeo/api/v2/employees/lists?pageSize=10&pageIndex=0&[email protected]&fields=information,workInfo,address,family&employeeRefId=24008' \
--header 'Ocp-Apim-Subscription-Key: WPe123a9RKbcfLQNSztr45' \
--header 'Authorization: bearer {your token}' \
--header 'Content-Type: application/json'

Responses

🟢200Success

application/json

Body

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

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
        }
    ]
}