Get List Employees - Gofive OpenAPI

Request

Query Params

pageSize

string

required

Total number of record to be retrieved (Maximum 1000)

Example:

10

pageIndex

string

required

Start index of the record to be skipped

Example:

0

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:

XDm388h2UOxjzVPTAqhs23

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/v1/profiles/list?pageSize=10&pageIndex=0' \
--header 'Ocp-Apim-Subscription-Key: XDm388h2UOxjzVPTAqhs23' \
--header 'Content-Type: application/json'

Responses

🟢200Success

application/json

Body

statusCode

integer

required

message

string

required

error

string

required

data

object

required

total

integer

required

employees

array [array]

required

Example

{
  "statusCode": 0,
  "message": "string",
  "error": "string",
  "data": {
    "total": 0,
    "employees": [
      [
        {
          "employeeRefId": "string",
          "firstName": "string",
          "lastName": "string",
          "firstNameEN": "string",
          "lastNameEN": "string",
          "nickName": "string",
          "nickNameEN": "string",
          "dateHired": "string",
          "contact": {
            "emailAddress": "string",
            "telephoneNo": "string"
          },
          "workingInformation": {
            "position": "string",
            "companyId": 0,
            "status": 0,
            "typeId": 0,
            "type": "string",
            "salary": 0,
            "managerRefId": "string",
            "emailAddress": "string",
            "telephoneNo": "string",
            "imagePath": "string",
            "organization": {
              "level1": "string",
              "level2": "string",
              "level3": "string",
              "level4": "string",
              "level5": "string",
              "level6": "string"
            }
          },
          "information": {
            "genderId": 0,
            "gender": "string",
            "address": "string",
            "road": "string",
            "subDistrict": "string",
            "district": "string",
            "province": "string",
            "postCode": "string",
            "mobileNo": "string",
            "region": "string",
            "national": "string",
            "identificationNo": "string",
            "height": 0,
            "weight": 0,
            "militaryStatusId": 0,
            "millitaryStatus": "string",
            "maritalStatusId": 0,
            "maritalStatus": "string",
            "relationships": [
              {
                "relationshipTypeId": 0,
                "relationshipType": "string",
                "firstName": "string",
                "lastName": "string",
                "contact": "string"
              }
            ]
          },
          "educations": [
            {
              "sequence": 0,
              "institution": "string",
              "major": "string",
              "degreeId": 0,
              "degree": "string",
              "fromYear": 0,
              "toYear": 0
            }
          ],
          "workExperiences": [
            {
              "company": "string",
              "dateFrom": "string",
              "dateTo": "string",
              "position": "string",
              "jobDescription": "string",
              "salary": 0,
              "resignationReasonId": "string",
              "resignationReason": "string"
            }
          ]
        }
      ]
    ]
  }
}