GET/api/public/v1/classes/{id}/members

class_members.list

所需权限
roster:read
可选权限
students:pii
类别
只读
计费
不计费
幂等
不需要
MCP 工具
list_class_members

参数

  • id位置 path必填 是类型 string (uuid)
  • cursor位置 query必填 否类型 string
  • limit位置 query必填 否类型 integer (1–100)

请求体

没有请求体

成功响应 200

{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "role": {
            "type": "string",
            "enum": [
              "student",
              "assistant"
            ]
          },
          "hasAccount": {
            "type": "boolean"
          },
          "joinedAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "pii": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "studentNo": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "required": [
                  "name",
                  "studentNo"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "revision": {
            "type": "string",
            "pattern": "^[A-Za-z0-9_-]{43}$"
          }
        },
        "required": [
          "id",
          "role",
          "hasAccount",
          "joinedAt",
          "createdAt",
          "pii",
          "revision"
        ],
        "additionalProperties": false
      }
    },
    "nextCursor": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2048,
          "pattern": "^[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]{43}$"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "items",
    "nextCursor"
  ],
  "additionalProperties": false
}

可能返回的错误状态码

400401403404409429500503

所有错误都用同一种错误信封返回,原因码见错误与限流。

GET /api/public/v1/classes/{id}/members · 接口参考