DocsAPI 文件Groups API
👤 全部

Groups API

跑團群組完整 API — CRUD、活動列表、群組統計。

POST /groups

建立群組。

Headers

Header必填
`x-api-key`API Key

Request Body

參數類型必填說明
`name`string群組名稱
`owner_id`string擁有者 ID
`description`string描述
`privacy`string隱私設定(`public` / `private`,預設 `public`)

Response (201)

{"group_id": "abc123", "message": "Group created"}


GET /groups

取得群組列表。

行為

  • 教練(membership_roles 含 coach,有 org_id):回傳組織的所有群組
  • 選手:回傳自己擁有/加入的群組

Query Parameters

參數類型說明
`user_id`string使用者 ID
`page_size`int每頁數量(預設 20)

Response (200)

欄位類型說明
`groups`array群組列表
`count`number總數
`page_size`number每頁數量

Group 物件

欄位類型說明
`group_id`string群組 ID
`name`string名稱
`description`string描述
`owner_id`string擁有者 ID
`org_id`string組織 ID
`privacy`string隱私設定
`members_count`number成員數
`created_at`number建立時間(epoch ms)

GET /groups/{group_id}

取得群組詳情。


PUT /groups/{group_id}

更新群組。

Request Body

參數類型說明
`name`string新名稱
`description`string新描述
`privacy`string新隱私設定

DELETE /groups/{group_id}

刪除群組。


GET /groups/{group_id}/activities

取得群組成員的活動列表(Activity Feed)。

Query Parameters

參數類型說明
`page_size`int每頁數量
`last_created_at`number分頁游標

GET /groups/{group_id}/stats

取得群組統計。

Response (200)

欄位類型說明
`total_members`number成員總數
`active_members`number本週活躍成員
`total_distance`number總跑量(公尺)
`total_activities`number總活動數
`avg_distance_per_member`number人均跑量