List all existing heartbeat groups

Returns a list of all your heartbeat groups.

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

Headers

Authorization
required string
200

Response body

{
  "data": [
    {
      "id": "123456",
      "type": "hearbeat_group",
      "attributes": {
        "name": "Backend services",
        "sort_index": 0,
        "created_at": "2020-10-03T20:20:43.547Z",
        "updated_at": "2020-10-03T20:20:43.547Z",
        "paused": false
      }
    }
  ],
  "pagination": {
    "first": "https://uptime.betterstack.com/api/v2/monitor-groups?page=1",
    "last": "https://uptime.betterstack.com/api/v2/monitor-groups?page=1",
    "prev": null,
    "next": null
  }
}

Example cURL

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