Skip to main content
Custom Role Group Query API

Enables you to list all role groups.

Updated over 4 months ago

What is the Custom Role Group Query API?

Custom Role Group Query API enables you to list all role groups.


API Calling

The API enables you to list all role groups.

Request Frequency: 30 times/second

Request Method: POST

Request Parameters:

Parameter

Type

Required

Description

skip

Integer

No

Offset

Limit

Integer

No

Limit

has_internal

Boolean

No

Whether to include custom role groups,

defaults to true.

Sample Request:

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

Responses:

Parameter

Type

Required

Description

group_no

Number

Yes

Role group number

name

String

Yes

Role group name

Type

Number

Yes

Role group types

0: regular role group

status

Number

Yes

1: in use

Sample Response:

{
    "role_groups": [
        {
            "group_no": 2547,
            "name": "Default",
            "type": 0
            "status": 1
        },
        {
            "group_no": 2550,
            "name": "CRM role group",
            "type": 0
            "status": 1
        },
        {
            "group_no": 2556,
            "name": "Marketing center",
            "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?