[ PROMPT_NODE_27054 ]
workspaces
[ SKILL_DOCUMENTATION ]
# Workspaces API
## 概述
protocols.io 中的工作区(Workspaces)通过组织协议、管理成员和控制访问权限来实现团队协作。Workspaces API 允许您列出工作区、管理成员资格以及访问特定工作区的协议。
## 基础 URL
所有工作区端点均使用以下基础 URL:`https://protocols.io/api/v3`
## 工作区操作
### 列出用户工作区
检索经过身份验证的用户有权访问的所有工作区。
**端点:** `GET /workspaces`
**查询参数:**
- `page_size`: 每页结果数(默认:10,最大:50)
- `page_id`: 分页页码(从 0 开始)
**响应包含:**
- 工作区 ID 和名称
- 工作区类型(个人、群组、机构)
- 成员数量
- 访问级别(所有者、管理员、成员、查看者)
- 创建日期
**请求示例:**
bash
curl -H "Authorization: Bearer YOUR_TOKEN"
"https://protocols.io/api/v3/workspaces"
### 获取工作区详情
检索特定工作区的详细信息。
**端点:** `GET /workspaces/{workspace_id}`
**路径参数:**
- `workspace_id`: 工作区的唯一标识符
**响应包含:**
- 完整的工作区元数据
- 包含角色的成员列表
- 工作区设置和权限
- 协议数量和分类
## 工作区成员资格
### 列出工作区成员
检索工作区的所有成员。
**端点:** `GET /workspaces/{workspace_id}/members`
**查询参数:**
- `page_size`: 每页结果数
- `page_id`: 分页页码
**响应包含:**
- 成员姓名和电子邮件
- 角色(所有者、管理员、成员、查看者)
- 加入日期
- 活动状态
### 请求工作区访问权限
申请加入工作区。
**端点:** `POST /workspaces/{workspace_id}/join-request`
**请求体:**
- `message` (可选): 向工作区管理员解释请求的消息
**请求示例:**
bash
curl -X POST
-H "Authorization: Bearer YOUR_TOKEN"
-H "Content-Type: application/json"
-d '{
"message": "我正在与 Smith 博士合作 CRISPR 项目,希望访问共享协议。"
}'
"https://protocols.io/api/v3/workspaces/12345/join-request"
### 加入公共工作区
无需批准直接加入公共工作区。
**端点:** `POST /workspaces/{workspace_id}/join`
**注意**:仅适用于配置为允许公开加入的工作区
## 工作区协议
### 列出工作区协议
检索所有协议