Skip to main content
All CollectionsOpen PlatformAPIContact APIs
Member Retrieval (Recursively) API
Member Retrieval (Recursively) API

Enables you to recursively obtain all members under a specified department ID.

Updated over 4 months ago

What is Member Retrieval (Recursively) API?

Member Retrieval API (Recursively) enables you to recursively obtain all members under a specified department ID.


API Calling

The API enables you to recursively obtain all members under a specified department ID.

Request Frequency: 10 times/second

Request Method: POST

Request Parameters:

Parameter

Type

Required

Description

dept_no

number

Yes

Department number

has_child

Boolean

No

The system is set not to recursively obtain all members. That is, you can only obtain the members in the current department instead of those in other sub-departments.

Sample Request:

{
   "dept_no":1,
  "has_child": true
}

Sample Response:

Parameter

Description

users

The list of members in the currently specified department

The returned data structure for one member could be as follows:

Parameter

Description

Notes

name

Nickname

The name of members can be duplicated, and members with the same name will have the same 'name' value.

username

Username

Within a company, the username is unique, but there may be duplicates across different companies.

departments

The department list of users

/

type

Department type

0: regular department

status

Department status

1: department in use

Sample Response:

{
  "users": [
    {
      "username": "aubrey",
      "name": "aubrey",
      "departments": [1],
      "type": 0,
      "status": 1
    }
  ]
}

I have finished reading. 🏆

👉I can't wait to SET THE API.

👉I need more HELP in Discord Forum.

Did this answer your question?