Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced guide
  5. Incidents
    1. Get started
    2. Advanced guide
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
    4. Migrating to pay as you go
  9. Uptime API
    1. Get an API token
    2. Monitors
    3. Heartbeats
      1. Heartbeats API
      2. Heartbeat groups API
        1. List heartbeat groups GET
        2. Get heartbeat group GET
        3. Create heartbeat group POST
        4. Update heartbeat group PATCH
        5. Remove heartbeat group DELETE
        6. Response attributes
    4. On-call & incidents
    5. Status pages
    6. Metadata
    7. Integrations

Get 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 $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",
      "team_name": "Test team",
      "paused": false
    }
  }
}

Example cURL

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

Previous article

List heartbeat groups

Next article

Create heartbeat group