Organization

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

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

Request header common

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access key ID issued on the NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with the secret key mapped to the access key ID * Uses HmacSHA256 for the HMAC encryption algorithm

Organization list search API

Searches the organization list.

Request URL

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

Request path parameter

Parameter	Type	Size	Requirement status	Description
partnerId	String	15	Y	Partner ID provided by WORKPLACE
companyId	String	36	Y	Linkage key (CompanyId) of customer to be searched `Developers > Basic settings > Linkage key`

Request parameter

Parameter	Type	Size	Requirement status	Description
offset	long		N	Displays offset rows first
limit	long		N	Displays as many as the number of limits

Request body parameter

Parameter	Type	Size	Requirement status	Description
tenantId	String	100	Y	Customer tenant ID
companyId	String	100	Y	Customer company ID
name	String	100	Y	Department name
i18nNames	Map		N	Localized department name`Map<Locale, String> i18nNames`
deptExternalKey	String	100	Y	Department external key
parentDeptExternalKey	String	100	Y	Parent department external key (# only for the top level organization)
deptEmailAddress	String	100	N	Department email address
externalEmailReceiveYn	boolean		N	External email reception status
dispOrd	String	10	Y	Display order of departments in organization chart
deptNo	String	36	Y	Department key
parentDeptNo	String	36	Y	Parent department key (# only for the top level organization)
deptLeaderEmpId	String	36	Y	empId of department head

Request examples

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

GET /partner/apigw/v2/partner/partnertestid/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/department?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, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

~~~ text
{
    "elements": [
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "Development team",
            "i18nNames": {},
            "parentDeptExternalKey": null,
            "deptLeaderExternalKey": "",
            "deptEmailAddress": "",
            "externalEmailReceiveYn": false,
            "dispOrd": "1.0",
            "deptNo": "partner-test202202000001",
            "parentDeptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "deptLeaderEmpId": null
        },
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "Planning team",
            "i18nNames": {},
            "parentDeptExternalKey": null,
            "deptLeaderExternalKey": "",
            "deptEmailAddress": "",
            "externalEmailReceiveYn": false,
            "dispOrd": "2.0",
            "deptNo": "partner-test202202000002",
            "parentDeptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "deptLeaderEmpId": null
        },
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "NAVER Cloud Corporation",
            "i18nNames": {
                "ko_KR": "workplace02"
            },
            "parentDeptExternalKey": null,
            "deptLeaderExternalKey": "",
            "deptEmailAddress": "",
            "externalEmailReceiveYn": false,
            "dispOrd": "1.0",
            "deptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "parentDeptNo": "#",
            "deptLeaderEmpId": null
        }
    ],
    "totalCount": 3
}

Response

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

HTTP status code	Response message	Description
200	OK	General request made successfully
201	Created	Response code to the successful resource creation
400	Bad Request	Used for failed general request
500	Internal Server Error	- Response code to general server errors While 4XX error codes represent client-side errors, 5XX error codes represent server-side errors.

Response examples

{
    "status": 400,
    "code": -4020,
    "errors": [],
    "message": "parentDeptExternalKey is null"
}

Was this article helpful?

What's Next

Employee

Table of contents

Description
Request header common
Organization list search API
Response