Find department

GET

/v3/departments/lookup

Match departments by the entered department name, and return department ID and name.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://www.nocoly.com/v3/departments/lookup?name=undefined&orgId=Organization%20ID%20when%20using%20AppKey+Sign%20Not%20required%20when%20authenticating%20with%20AppKey.%20Returns%20department%20information%20for%20the%20organization%20that%20owns%20the%20app.%20Required%20when%20authenticating%20with%20a%20personal%20access%20token%20(PAT)%20%2F%20oauth.%20Pass%20the%20organization%20ID%20to%20query%20and%20return%20department%20information%20for%20the%20corresponding%20organization.' \
--header 'HAP-Appkey: {{appkey}}' \
--header 'HAP-Sign: {{sign}}'

Responses

🟢200Success

application/json

Departments found successfully

Bodyapplication/json

Example

{
    "data": {
        "departments": [
            {
                "id": "7fb381a3-d559-4b0c-a8fd-e1e8a6272442",
                "name": "Sales Department 1",
                "path": "East China Region/Shanghai Branch/Sales Department",
                "pathNodes": [
                    {
                        "id": "dep_000",
                        "name": "East China Region"
                    },
                    {
                        "id": "dep_001",
                        "name": "Shanghai Branch"
                    },
                    {
                        "id": "dep_002",
                        "name": "Sales Department"
                    }
                ]
            }
        ]
    },
    "success": true
}

Modified at 2026-06-25 10:21:06

Find member

Get region information