API DocsAPI Docs
get/api/group/{groupId}/members
get/api/group/{groupId}/members
获取小组成员列表
Basic Information
Request Method:
get
Request URL:
https://www.lycoo.com/api/group/{groupId}/members
Tags:
小组成员管理
Description
获取指定小组的成员列表,支持分页查询。
用途:
- 查看小组内的所有成员信息
- 分页获取成员列表,支持按加入时间或角色排序
Path Parameters
Path Parameters Explanation
Path parameters are variables in the URL path, for example:
https://www.lycoo.com/api/group/:groupId/members
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
groupId | string | Required | example | 小组ID |
Query Parameters
Query Parameters Explanation
Query parameters are added at the end of the URL, starting with a question mark, for example:
https://www.lycoo.com/api/group/{groupId}/members?page=10&pageSize=10&sortBy=example&sortOrder=example
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
page | integer | Optional | 10 | 页码,默认为1 |
pageSize | integer | Optional | 10 | 每页条目数,默认为10 |
sortBy | string | Optional | example | 排序字段,可选值有 joinedAt(加入时间)、role(角色) |
sortOrder | string | Optional | example | 排序方向,可选值有 asc(升序)、desc(降序) |
Header Parameters
Header Parameters Explanation
Header parameters are used to pass additional information, such as authentication credentials, content type, etc.
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
Authorization | string | Required | Bearer sha_1234567890abcdef... | The authentication header is used to verify the identity of API requests, containing an access token Format: Bearer {token} |
Response Example
200获取小组成员列表成功
{
"success": true
}
401
403无权限查看小组成员
{
"success": false,
"message": "您不是该小组成员,无法查看成员列表"
}
404
500