Skip to content

Get a List of Members



get /api/v1/workspace/members/list

Overview

List all members in the current workspace.

Query Request Parameter

Parameter Name Type Required Description
search string Search by name/mailbox
Example: supper_workspace
Allow null: False
pageIndex integer Page number
Allow null: False
Example: 10
$minValue: 1
pageSize integer Quantity returned per page
Allow null: False
Example: 10
$minValue: 1
$maxValue: 100

Supplementary Description of Parameters

Request Example

curl 'https://openapi.guance.com/api/v1/workspace/members/list?pageIndex=1&pageSize=2' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed \
--insecure

Response

{
    "code": 200,
    "content": [
        {
            "createAt": 1614149795,
            "creator": "extend",
            "deleteAt": -1,
            "email": "88@qq.com",
            "extend": {
                "user_icon": "acnt_6f2fd4c0766d11ebb56ef2b2c21faf74.png"
            },
            "exterId": "acnt-gtxSK4UrogwM3N2guGNGim",
            "id": 19,
            "mobile": "",
            "name": "测试",
            "nameSpace": "",
            "role": "owner",
            "status": 0,
            "updateAt": 1614149795,
            "updator": "external",
            "userIconUrl": "http://static.cloudcare.cn:10561/icon/acnt_6f2fd4c0766d11ebb56ef2b2c21faf74.png",
            "userType": "common",
            "username": "88@qq.com",
            "uuid": "acnt_6f2fd4c0766d11ebb56ef2b2c21faf74",
            "waitAudit": 0
        }
    ],
    "errorCode": "",
    "message": "",
    "pageInfo": {
        "count": 1,
        "pageIndex": 1,
        "pageSize": 3,
        "totalCount": 1
    },
    "success": true,
    "traceId": "TRACE-DA203788-B799-4BE2-9AB4-552047E01EED"
} 

Feedback

Is this page helpful? ×