Viewing department list

Prev Next

Available in Classic and VPC

It is an API to view the Media Connect Center department list.

Requests

GET https://ncloudmcc.apigw.ntruss.co/ncloudmcc/v1/companies/{companyId}/depts

Request headers

Item Required Description
x-ncp-apigw-timestamp Y Time elapsed since January 1, 1970, 00:00:00 UTC in milliseconds. The request is considered invalid if the time difference from the API Gateway server is 5 minutes or longer
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Y Value of access key ID issued from NAVER Cloud Platform portal
x-ncp-iam-access-key:{Sub Account Access Key}
x-ncp-apigw-signature-v2 Y Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-region_code N Region code (KR)
x-ncp-region_code:KR
Content-Type Y Specifies the request body content type as application/json
Content-Type: application/json

Request path parameters

Parameters Type Size Required Description
companyId String 36 Y Integration key (CompanyId)
Developers > Basic settings > Integration key

Request query parameters

Parameters Type Size Required Description
limit Number N Maximum number of items to be returned, default 10
offset Number N Offset of the first item to be returned from the collection, default 0

Request body parameters

Parameters Type Size Required Description

Request examples

GET /ncloudmcc/v1/companies/48128f23-e29b-496e-aa04-1f741fed86bc/depts?limit=2&offset=1
Host: ncloudmcc.apigw.ntruss.com
x-ncp-apigw-signature-v2: +4kkeJ+hRUcWH4xsXDQvuDEzfpqDRPr4D+Gc+GnFPHo=
x-ncp-apigw-timestamp: 1700470912198
x-ncp-iam-access-key: HrR0s91elfiXEeTSZcwj
x-ncp-region_code: KR

Responses

Response body parameters

Parameters Type Size Required Description
page.count Number Number of items returned
page.offset Number Offset of the first item returned
page.limit Number Maximum number of items returned
page.total Number Total number of items in the collection
depts[].name String 100 Department name
depts[].i18nNames Map Multilingual department name
Map<Locale, String> i18nNames
depts[].sortOrd Number 1 Order of department to be exposed
depts[].externalKey String 36 External key of department
depts[].uprDeptExternalKey String 50 Y External key of the upper department; the highest default department if not specified

Response examples

HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Date: Mon, 20 Nov 2023 09:01:52 GMT
Server: nginx
x-ncp-apigw-response-origin: ENDPOINT
x-ncp-trace-id: 68e9pckqm4c356coj1ckpjicpo

{
    "page":
    {
        "count":2,
        "offset":1,
        "limit":2,
        "total":3
    },
   "depts":
   [
        {
            "name":"Sales",
            "i18nNames":
            {
                "ko_KR": "영업",
                "en_US": "Sales"
            },
            "uprDeptExternalKey": "dept00",
            "sortOrd":0,
            "externalKey":"dept01"
        },
        {
            "name":"Marketing",
            "i18nNames":
            {
                "ko_KR": "마케팅",
                "en_US": "Marketing"
            },
            "uprDeptExternalKey":"dept00",
            "sortOrd":0,
            "externalKey":"dept02"
        }
    ]
}