---
title: "GET /heartbeat"
method: GET
path: "/heartbeat"
tags: ["heartbeat"]
---

# GET /heartbeat

`GET /heartbeat`

チャンネルを現在見ている人・編集している人を取得します。

## Query parameters

- `channelId` string, uuid, required

## Response `200`

正常に取得できました。

- HeartbeatRes
  - `userStatuses` object[]
    - `userId` string, uuid — ユーザーUUID
    - `status` 'none' | 'monitoring' | 'editing' — editing,monitoring,noneのユーザーの状態
  - `channelId` string, uuid — チャンネルUUID

## Changes

- **2019-07-24** `66a69a1387ed` — 1 info
  - api operation id `getHeartbeat` was added
- **2019-07-05** `6956f2622a20` — 1 breaking, 5 info
  - added the new required `query` request parameter `channelId`
  - api operation id `getHeartbeat` removed and replaced with ``
  - the endpoint scheme security `traqOAuth2` was added to the API
  - endpoint reactivated
  - …2 more

[Change history](https://skmtc.dev/traptitech/apis/traq-api/changes/heartbeat/get.md)

---

[API](https://skmtc.dev/traptitech/apis/traq-api.md) · [All operations](https://skmtc.dev/traptitech/apis/traq-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/traptitech/traq-api/revisions/4ab97bc4eb2c/schema)