获取企业成员列表 - Teambition API

该接口用于获取企业的成员列表。

curl --location --request GET 'https://open.teambition.com/api/org/member/list' \ --header 'Authorization: Bearer <appAccessToken>' \ --header 'X-Tenant-Id: 50c32af35a87e6b2...' \ --header 'X-Tenant-Type: organization' \ --header 'Content-Type: application/json' \ --data-raw ''

{ "code": 200, "errorMessage": "", "count": 100, "nextPageToken": "dd28c9aa-e056-4f57-9f6c-ed5c3b2d7200", "result": [ { "userId": "5a28e2036176bbde...", "isDisabled": 0, "role": 0, "name": "张三", "pinyin": "Zhang San", "py": "ZS", "email": "zhangsan@test.com", "birthday": "1990-10-01", "entryTime": "2019-12-30", "staffType": "正式", "title": "开发工程师", "phone": "136****0101", "country": "中国", "province": "浙江", "city": "杭州" } ] }

请求参数

Header 参数

Authorization

string

可选

appAccessToken 的生成方式见授权凭证

示例值:

Bearer <appAccessToken>

X-Tenant-Id

string

企业 ID

可选

示例值:

50c32af35a87e6b2...

X-Tenant-Type

string

可选

示例值:

organization

Body 参数application/json

orgId

string

企业 ID

必需

pageToken

string

可选

分页 token，首次获取数据时为空

pageSize

integer

可选

返回结果数量，默认 30，最大 1000

filter

string

可选

该参数用于指定查询范围： initiate：新加入的成员 disabled：已禁用的成员 enabled：未禁用的成员 external：外部成员

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

返回码，200 表示成功

errorMessage

string

必需

调用失败时的错误信息

count

integer

接口返回的数据量

必需

nextPageToken

string

必需

下一页的分页 token

result

object (result2)

必需

birthday

string

出生日期

可选

city

string

工作地点（城市）

可选

country

string

工作地点（国家）

可选

string

电子邮箱

可选

entryTime

string

入职时间

可选

isDisabled

integer

可选

成员账号是否被停用：0 启用，1 停用

name

string

成员名称

可选

phone

string

联系电话

可选

province

string

工作地点（省份）

可选

role

integer

可选

成员角色，取值为： 0：成员 1：管理员 2：拥有者

staffType

string

员工类型

可选

title

string

职位

可选

userId

string

用户 ID

可选

pinyin

string

成员名称的拼音

可选

string

成员名称的拼音简写

必需