> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hypersender.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Heartbeat Management

> List SMS phone heartbeats using Hypersender's Laravel Package

## Overview

Monitor and query your phone's heartbeats with Hypersender's Laravel SDK. This page shows how to list heartbeats with pagination, sorting, includes, and filters.

## Methods

### List Heartbeats

Index heartbeats of the phone sorted by last heartbeat. [(learn more)](/api-reference/sms/heartbeats/heartbeats)

<Tabs>
  <Tab title="Basic Usage" icon="code">
    ```php theme={null}
    use Hypersender\Hypersender;

    $response = Hypersender::sms()->getHeartbeats();
    ```
  </Tab>

  <Tab title="Basic Usage with Filters" icon="code">
    ```php theme={null}
    use Hypersender\Hypersender;

    $request = app(HeartbeatsIndexRequest::class, [
        'perPage' => '50',
        'page' => '1',
        'sort' => '-created_at',
        'include' => 'phone',
        'filter' => [
            'app_version' => '1.2.3',
            'battery_level' => 87,
            'is_charging' => true,
            'local_timestamp' => '2025-01-20 14:30:00',
            'created_at' => '2025-01-20 00:00:00..2025-01-21 00:00:00',
            // other filters (check Parameters tab)
        ],
    ]);

    $response = Hypersender::sms()->getHeartbeats($request);
    ```
  </Tab>

  <Tab title="Parameters" icon="sliders">
    | Parameter                 | Type   | Required | Description                                    |
    | ------------------------- | ------ | -------- | ---------------------------------------------- |
    | per\_page                 | int    | no       | Number of items per page (max 50)              |
    | page                      | int    | no       | Page number to retrieve                        |
    | sort                      | string | no       | Sort fields (e.g., `-created_at`)              |
    | include                   | string | no       | Related resources to include (comma-separated) |
    | filter\[app\_version]     | string | no       | Filter by app version                          |
    | filter\[battery\_level]   | int    | no       | Filter by battery level percentage             |
    | filter\[is\_charging]     | bool   | no       | Filter by charging status                      |
    | filter\[local\_timestamp] | string | no       | Filter by device local timestamp or range      |
    | filter\[created\_at]      | string | no       | Filter by created\_at timestamp or range       |
  </Tab>
</Tabs>
