---
title: "List heartbeats"
method: GET
path: "/api/{cloudId}/v1/teams/{teamId}/heartbeats"
tags: ["Heartbeats"]
---

# List heartbeats

`GET /api/{cloudId}/v1/teams/{teamId}/heartbeats`

Lists the all heartbeats user can view. If a heartbeatName is passed, it filters out given heartbeat and only return given heartbeat.

## Path parameters

- `teamId` string, required

## Query parameters

- `name` string
- `offset` integer
- `size` integer

## Response `200`

Returned if the request is successful

- HeartbeatPaginatedResponse
  - `values` Heartbeat[]
    - `name` string — Name of the heartbeat.
    - `description` string — Description of the heartbeat.
    - `interval` integer — Specifies how often a heartbeat message should be expected.
    - `intervalUnit` 'Days' | 'Minutes' | 'Hours'
    - `enabled` boolean — Enable/disable heartbeat monitoring.
    - `status` 'Unresponsive' | 'Responsive' | 'Off' | 'Pending'
    - `ownerTeamId` string — Owner team of the heartbeat, consisting id of the owner team
    - `alertMessage` string — Specifies the alert message for heartbeat expiration alert.
    - `alertTags` string[] — Specifies the alert tags for heartbeat expiration alert.
    - `alertPriority` 'P1' | 'P2' | 'P3' | 'P4' | 'P5' — Specifies the alert priority for heartbeat expiration alert.
  - `links` HeartbeatLinks
    - `next` string — Link to the next page of results.

## Other responses

- `401` — Returned if the authentication credentials are incorrect.
- `402` — Returned if the customer subscription plan does not cover heartbeats.
- `403` — Returned if the request user does not have permission to edit heartbeats.

---

[API](https://skmtc.net/atlassian/apis/jsm-operations-api.md) · [All operations](https://skmtc.net/atlassian/apis/jsm-operations-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jsm-operations-api/versions/ed65f017bcb8/schema)