Get a single heartbeat group

Returns an existing heartbeat group by ID.

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

Query parameters

heartbeat_group_id
required string

Headers

Authorization
required string
200

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

curl --request GET \
  --url https://betteruptime.com/api/v2/heartbeat-groups/123456 \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Copied!