灵途小工单灵途小工单
首页文档
进入工作台
开发文档OpenAPI

开始使用

  • 介绍
  • 快速开始
  • 认证与权限

业务 API

  • 账号与空间
  • 工单
  • 客户
  • 供应商
  • 收支
  • 标签与统计
  • 交流

接口约定

  • 请求与响应
  • 附件
  • 错误与重试
目录 · 账号与空间

开始使用

  • 介绍
  • 快速开始
  • 认证与权限

业务 API

  • 账号与空间
  • 工单
  • 客户
  • 供应商
  • 收支
  • 标签与统计
  • 交流

接口约定

  • 请求与响应
  • 附件
  • 错误与重试

账号与空间

发现身份、可访问空间,以及业务指派所需的成员公开资料。

身份与空间选择

GET me 返回 id、name、email;GET workspaces 返回空间 id、name、role、isOwner。成员接口只返回 id、name、avatarUrl、role,不包含证件或银行卡等私人资料。

空间列表支持分页。不要猜测空间 ID,也不要在未确认空间时开始写入。

接口参考

GET

查询本人身份

/api/v1/me

响应 data 字段
id
账号 ID
name
昵称
email
邮箱,可为空
cURL
curl --request GET "$XGD_BASE_URL/api/v1/me" \
  --header "Authorization: Bearer $AGENT_API_KEY"

成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。

GET

查询可访问空间

/api/v1/workspaces

响应 data 字段(列表元素)
id
空间 ID
name
空间名称
role
本人在空间内的角色
isOwner
是否为空间所有者
cURL
curl --request GET "$XGD_BASE_URL/api/v1/workspaces" \
  --header "Authorization: Bearer $AGENT_API_KEY"

成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。

GET

查询成员公开资料

/api/v1/workspaces/{workspaceId}/members

响应 data 字段(列表元素)
id
用户 ID
name
空间昵称
avatarUrl
头像地址,可为空
role
空间角色
cURL
curl --request GET "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/members" \
  --header "Authorization: Bearer $AGENT_API_KEY"

成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。

上一篇认证与权限下一篇工单

本页内容

身份与空间选择接口参考

深圳市灵途造物科技有限责任公司

客户需求,有记录,有跟进。

© 2026 灵途造物|粤ICP备2025506773号-3