Skip to main content

Member Information Query API

Enables you to get the name and department number of the specified member according to username.


What is the Member Information Query API?

The Member Information Query API enables you to retrieve the name, department numbers, and custom member information field values of a specified member according to username.

This API supports Public Mode and Integration Mode.


API Version History

API Version

Update Date

Description

v1

December 4, 2018

Used _id as the ID.

v2

June 21, 2019

Changed the ID to username.

v4

June 30, 2022

Added type, status, and integrate_id to the response.

v5

October 28, 2022

Increased the request rate from 5 to 30 requests per second, moved username to the request body, and changed the endpoint to POST corp/user/get.

v6

October 28, 2026

Added ext to the member information response to support reading custom member information fields.


API Calling

The API enables you to retrieve the name, department numbers, and custom member information field values of a specified member according to username.

Request Rate: 30 times/second

Request Method: POST

Request Body Format: JSON

Request Parameters:

Parameter

Required

Type

Description

username

Yes

String

Refers to User No. in Contacts.

Request Sample:

{
    "username": "jodoo"
}

Responses:

Parameter

Type

Description

user

Object

Member information. For basic fields, see the member object structure (user) in Contact APIs.

user.ext

Object

Custom member information field values. Only enabled fields with non-empty values are returned.

Sample Response:


{
"user": {
"username": "jodoo",
"name": "Harry",
"departments": [1, 3],
"type": 0,
"status": 1,
"integrate_id": "jodoo",
"ext": {
"_widget_0300000000013": "EMP001"
}
}
}
```

I have finished reading. 🏆

👉I can't wait to SET THE API.

👉I need more HELP in Discord Forum.

Did this answer your question?