Skip to main content
2023-12-13 02:52 更新Version: latest

团队和部门

获取团队下的成员列表

请求地址

GET /teams/{teamGuid}/members?pagination=true&page={page}&pageSize={pageSize}

HTTP Request Headers

Header 名说明
X-Shimo-Token接入方提供的 Token用于接入方对本次请求鉴权

HTTP Query Parameters

参数名类型说明
paginationbooleantrue是否为分页查询
pagenumber1分页查询第几页
pageSizenumber10分页大小

HTTP Response Body

字段名类型值示例说明
items[0].idstringuserid123接入方系统的用户 ID
items[0].namestring张三接入方系统的用户名称
items[0].avatarstringhttp://fake.site/user-123.png接入方系统的用户头像地址
items[0].emailstringuser123@fake.site接入方系统的用户邮箱

Response Body Example

[
{
"id": "userid123",
"name": "张三",
"avatar": "http://fake.site/user-123.png",
"email": "user123@fake.site"
},
{
"id": "userid1234",
"name": "李四",
"avatar": "http://fake.site/user-123.png",
"email": "user123@fake.site"
}
]

获取部门信息

提示

当部门 ID 为根节点 ID 时,以特殊形式传递部门 ID ,参考 特殊部门 ID 说明

请求地址

GET /departments/{departmentId}

HTTP Request Headers

Header 名说明
X-Shimo-Token接入方提供的 Token用于接入方对本次请求鉴权

HTTP Response Body

字段名类型值示例说明
idstring123接入方系统的部门 ID
namestring研发部接入方系统的部门名称
allMemberCountnumber99接入方当前部门下的所有成员数量

Response Body Example

{
"id": "123",
"name": "研发部",
"allMemberCount": 99
}

获取部门的下级部门节点

提示

当部门 ID 为根节点 ID 时,以特殊形式传递部门 ID ,参考 特殊部门 ID 说明

请求地址

GET /departments/{departmentId}/children

HTTP Request Headers

Header 名说明
X-Shimo-Token接入方提供的 Token用于接入方对本次请求鉴权

HTTP Response Body

字段名类型值示例说明
items[0].idstring123接入方系统的部门 ID
items[0].namestring研发部接入方系统的部门名称
items[0].allMemberCountnumber99接入方当前部门下的所有成员数量

Response Body Example

[
{
"id": "123",
"name": "研发部",
"allMemberCount": 99
},
{
"id": "124",
"name": "财务部",
"allMemberCount": 10
}
]

获取部门下的成员分页列表

提示

当部门 ID 为根节点 ID 时,以特殊形式传递部门 ID ,参考 特殊部门 ID 说明

请求地址

GET /departments/{departmentId}/members?page={page}&pageSize={pageSize}

HTTP Request Headers

Header 名说明
X-Shimo-Token接入方提供的 Token用于接入方对本次请求鉴权

HTTP Query Parameters

参数名类型说明
pagenumber1分页查询第几页
pageSizenumber20分页大小

HTTP Response Body

字段名类型值示例说明
totalnumber20接入方系统部门下的成员总数
members[0].idstringuserid123接入方系统的用户的 ID
members[0].namestring张三接入方系统的用户名称
members[0].avatarstringhttp://fake.site/user-123.png接入方系统的用户头像地址
members[0].emailstringuser123@fake.site接入方系统的用户邮箱

Response Body Example

{
"total": 20,
"members": [
{
"id": "userid123",
"name": "张三",
"avatar": "http://fake.site/user-123.png",
"email": "user123@fake.site"
},
{
"id": "userid1234",
"name": "李四",
"avatar": "http://fake.site/user-123.png",
"email": "user123@fake.site"
}
]
}