---
title: "Retrieve a heartbeat check"
method: GET
path: "/heartbeat/{test_id}"
tags: ["heartbeat"]
---

# Retrieve a heartbeat check

`GET /heartbeat/{test_id}`

Returns a heartbeat check with the given id.

## Path parameters

- `test_id` string, required

## Response `200`

OK

- HeartbeatTestResponse
  - `data` HeartbeatTest, required
    - `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
    - `host` string — Name of the hosting provider
    - `last_tested_at` string, date-time — When the check was last run (RFC3339 format)
    - `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, required — Uptime percentage for a check

## 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)