Member List Query (Role) - Jodoo

Member List Query (Role)API Explorer

Introduction

API Introduction

Member List Query API (Role) enables you to list members under a role.

Note:
It will only return members who are in the invitation status or have been activated.

API Version

API Version

Updated Time

Description

2023.10.11

1. Add a new request parameter.

Whether the information of assigned departments is included: has_manage_range

2. Add a new response parameter.

Assigned department ID: departments_range
Whether a sub-department is included: has_child

API Calling

The API enables you to list members under a role.

Request URL: https://api.jodoo.com/api/v5/corp/role/user/list

Request Frequency: 30 times/second

Request Method: POST

Request Parameters:

Parameter	Location	Required	Description
skip	Number	No	Offset-based pagination
limit	Number	No	Pagination size
role_no	Number	Yes	Role number
has_manage_range	Boolean	No	Whether the information of assigned departments is included. The value is False by default.

Sample Request:

{
    "skip": 0,
    "limit": 3,
    "role_no": 3,
    "has_manage_range": True
}

Responses:

Parameter	Type	Required	Description
username	String	Yes	The number of a member, which is unique within the company.
name	String	Yes	Member username
departments	Number[]	Yes	IDs list of departments where the member belongs to
type	Number	Yes	Member type 0: regular member
status	Number	Yes	Status 0: unconfirmed members 1: joined
departments_range	Number[]	No	Assigned department ID Note: The parameter is only available to members who are configured assigned department.
has_child	Boolean	No	Whether a sub-department is included Note: The parameter is only available to members who are configured assigned department.

Sample Response:

{
    "users": [
  {
    "username": "jodoo-xulalikdbj82",
    "name": "frank",
    "departments": [212],
    "type": 0,
    "status": 1,
    "deptarments_range": [378,1157],
    "has_child": true
  },
  {
    "username": "R-E9rRNbwL",
    "name": "Member deletion",
    "departments": [338,226],
    "type": 0,
    "status": 1,
    "deptarments_range": [1157],
    "has_child": false
  },
  {
    "username": "UPDATE",
    "name": "testadmin",
    "departments": [1],
    "type": 0,
    "status": 1
  }
   ]
}