Employee

Description

Searches the employee list of a customer connected to the partner company.

Employee list search API

Searches the employee list.

Request URL

GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/employee

Request header

Request path parameter

Request parameter

Request body parameter

Request examples

GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/partnertest/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/employee?offset=0&limit=10

GET 
/partner/apigw/v2/partner/partnertest/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/employee?offset=0&limit=10
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

Response examples

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 23 Feb 2022 05:17:06 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "elements": [
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "Employee Park",
            "i18nNames": {},
            "employYmd": "",
            "loginId": "testuser@sample.com",
            "emailAddress": "testuser@sample.com",
            "telephoneNo": "",
            "cellphoneNo": "",
            "empNo": null,
            "empId": "81aaa126-655d-2123-5903-94e95386e866",
            "deptNo": "partner-test202202000001",
            "nationCd": "",
            "residentRegistrationNumber": "",
            "genderCd": "",
            "birthYmd": "",
            "zipCode": "",
            "address": "",
            "addressDetail": "",
            "deptExternalKey": null,
            "gradeCdExternalKey": "",
            "jobCdExternalKey": "",
            "empTypeExternalKey": "",
            "empStatus" "IN",
            "concurrentDeptExternalKeys": [],
            "reportsToExternalKey": []
        },
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "Admin",
            "i18nNames": {},
            "employYmd": "",
            "loginId": "admin@sample.com",
            "emailAddress": "admin@sample.com",
            "telephoneNo": "",
            "cellphoneNo": "01012341234",
            "empNo": null,
            "empId": "41bc321a-a6d2-4b57-8f71-b7602993be84",
            "deptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "nationCd": "",
            "residentRegistrationNumber": "",
            "genderCd": "",
            "birthYmd": "",
            "zipCode": "",
            "address": "",
            "addressDetail": "",
            "deptExternalKey": null,
            "gradeCdExternalKey": "",
            "jobCdExternalKey": "",
            "empTypeExternalKey": "",
            "empStatus" "RETIRE",
            "concurrentDeptExternalKeys": [],
            "reportsToExternalKey": []
        }
    ],
    "totalCount": 2
}

Response

Returned as an HTTP status code and delivered as body information.

Response examples

{
    "status": 400,
    "code": -4001,
    "errors": [],
    "message": "This is a duplicate login ID"
}

Language codes supported

Time zone codes

Employee status code