List all existing heartbeats

Returns a list of all your heartbeats.

GET https://betteruptime.com/api/v2/heartbeats

Headers

Authorization
required string
200

Response body

{
  "data": [
    {
      "id": "12345",
      "type": "heartbeat",
      "attributes": {
        "url": "https://betteruptime.com/api/v1/heartbeat/abcd1234abcd1234abcd1234",
        "name": "Testing heartbeat",
        "period": 10800,
        "grace": 300,
        "call": false,
        "sms": false,
        "email": true,
        "push": true,
        "team_wait": 180,
        "heartbeat_group_id": null,
        "sort_index": null,
        "paused_at": null,
        "created_at": "2020-05-05T11:41:49.327Z",
        "updated_at": "2020-12-10T14:40:23.436Z",
        "status": "up"
      }
    }
  ],
  "pagination": {
    "first": "https://betteruptime.com/api/v2/heartbeats?page=1",
    "last": "https://betteruptime.com/api/v2/heartbeats?page=1",
    "prev": null,
    "next": null
  }
}

Example cURL

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