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

# Get all heartbeat checks

`GET /heartbeat`

Returns a list of heartbeat checks for an account.

## Query parameters

- `status` 'down' | 'up'
- `page` integer
- `limit` integer
- `tags` string
- `matchany` boolean
- `nouptime` boolean

## Response `200`

OK

- HeartbeatTests
  - `data` HeartbeatTestOverview[], required — List of heartbeat checks
    - `id` string, required — Heartbeat check ID
    - `name` string, required — Name of the check
    - `url` string, uri, required — URL of the check
    - `period` integer, required — Number of seconds since the last ping before the check is considered down
    - `contact_groups` string[], required — List of contact group IDs
    - `paused` boolean, required — Whether the check should be run
    - `status` 'down' | 'up', required — The returned status of a heartbeat check
    - `tags` string[], required — List of tags
    - `uptime` number, float — Uptime percentage for a check
  - `metadata` Pagination, required
    - `page` integer, required — The current page of results
    - `per_page` integer, required — The number of results per page
    - `page_count` integer, required — The total number of pages
    - `total_count` integer, required — The total number of results

## Other responses

- `default` — Unexpected Error

---

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