Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
      1. List all existing heartbeat groups GET
      2. Get a single heartbeat group GET
      3. Create a new heartbeat group POST
      4. Update an existing heartbeat group PATCH
      5. Delete an existing heartbeat group DELETE
      6. Heartbeat groups API response params
  11. On-call & Incidents API
    1. On-call calendar
    2. Escalation policies
    3. Incidents
  12. Integrations API
    1. Email integrations
    2. Incoming webhooks
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Get a single heartbeat group

Returns an existing heartbeat group by ID.

GET https://uptime.betterstack.com/api/v2/heartbeat-groups/{heartbeat_group_id}

Query parameters

heartbeat_group_id
required string

The ID of your heartbeat group.

Headers

Authorization
required string

Bearer $TEAM_TOKEN

200

Returns an existing heartbeat group

Response body

{
  "data": {
    "id": "123456",
    "type": "heartbeat_group",
    "attributes": {
      "name": "Backend services",
      "sort_index": 0,
      "created_at": "2020-09-18T17:20:42.514Z",
      "updated_at": "2020-09-18T17:21:27.251Z",
      "paused": false
    }
  }
}

Example cURL

Example
curl --request GET \
  --url https://uptime.betterstack.com/api/v2/heartbeat-groups/123456 \
  --header "Authorization: Bearer $TEAM_TOKEN"

Previous article

List all existing heartbeat groups

Next article

Create a new heartbeat group