获取工作区成员列表 - 伙伴云OpenAPI

请求参数

Header 参数

Open-Authorization

string

必需

授权的 API Key

默认值:

Bearer {{API_KEY}}

Body 参数application/json

username

string

搜索关键词

可选

用于对工作区成员名称进行搜索的关键词

limit

integer

单页条数

可选

默认 20 条，最大 100 条

offset

integer

分页偏移量

可选

默认 0

space_id

string

工作区ID

必需

示例

{
  "space_id": "{{SPACE_ID}}",
  "username": "张",
  "limit": 20,
  "offset": 0
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.huoban.com/openapi/v1/space/member/list' \
--header 'Open-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "space_id": "",
    "username": "张",
    "limit": 20,
    "offset": 0
}'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

0 为成功，小于 10000 为系统异常，其他为业务异常

message

string

错误信息

必需

具体的错误原因，code 为 0 时返回“success”

data

object

返回数据

必需

返回具体数据的结构

users

array[object (用户) {3}]

必需

meta

object

元数据

必需

用来描述返回数据原始信息

trace_id

string

请求ID

必需

每次请求接口会返回唯一的ID

示例

{
  "code": 0,
  "message": "success",
  "data": {
    "users": [
      {
        "user_id": "1000001",
        "name": "张三",
        "avatar": "https://hb-v4-public-oss.huoban.com/user_avatar/188597939/0?imageMogr2/thumbnail/128x128>"
      },
      {
        "user_id": "1000002",
        "name": "李四",
        "avatar": "https://hb-v4-public-oss.huoban.com/user_avatar/189867922/0?imageMogr2/thumbnail/128x128>"
      }
    ]
  },
  "meta": {
    "trace_id": "1650337384742756"
  }
}