Skip to main content

Get External User Info API

Introduction

This API retrieves the nickname, role IDs, and other information of a specified external user by username (Member No.).


API Version History

API Version

Update Date

Description

v6

November 12, 2026

Added the External User Information Query API.


API Calling

API Information

Item

Description

Request URL

Request Method

POST

Request Rate

30 requests/second

Request Body Format

JSON

Request Parameters

Parameter

Required

Type

Description

username

Yes

String

Member No. of the external user.

Sample Request

{     "username": "jodoo" }

API Response

Response Parameters

Parameter

Type

Description

user

Object

External user information.

user.username

String

Member No. of the external user.

user.name

String

Nickname of the external user.

user.roles

Number[]

List of role IDs assigned to the external user.

user.type

Number

Member type. 1: External user.

user.status

Number

Member status. 0: The external user has not joined the organization. 1: The external user has joined the organization.

Sample Response

{     "user": {
"username": "jodoo",
"name": "Alex",
"roles": [1, 3],
"type": 1,
"status": 1
}
}
Did this answer your question?