Role List Query API - Jodoo

Role List Query APIAPI Explorer

Introduction

API Introduction

Role List Query API enables you to list roles.

API Calling

The API enables you to list roles.

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

Request Frequency: 30 times/second

Request Method: POST

Request Parameters:

Parameter	Type	Required	Description
skip	Number	No	Offset
limit	Number	No	Limit, defaults to one if not provided
has_internal	Boolean	No	Whether to include self-built roles, defaults to true

Sample Request:

{
    "skip": 0,
    "limit": 3,
    "has_internal": true,
}

Responses:

Parameter	Type	Required	Description
role_no	Number	Yes	Role number
group_no	Number	No	Role group number
name	String	Yes	Role name
type	Number	Yes	Role type, 0 for regular role
status	Number	Yes	Status 0: unconfirmed members 1: joined

Sample Response:

{
    "roles": [
        {
            "role_no": 3,
            "group_no": 2547,
            "name": "Design center",
            "type": 0,
            "status": 1
        },
        {
            "role_no": 2551,
            "group_no": 2550,
            "name": "Sales manager",
            "type": 0,
           "status": 1
        },
        {
            "role_no": 2552,
            "group_no": 2550,
            "name": "Sales head",
            "type": 0,
           "status": 1
        }
    ]
}