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

# List kiosk devices

> Read kiosk devices for a merchant, including status, store, and app health.

Returns kiosk devices for the authenticated merchant. This is the same set shown on the kiosk devices page in the dashboard.

> [!NOTE]
>
> Requires an access token with the `kiosk:read` scope. See
> [Token](https://firespark.cloud/docs/integrations-api/oauth/token/post.md) to obtain a token.

## Request

```bash theme={null}
curl "https://firespark.cloud/api/integrations/v1/kiosk/devices?channel_id=kioscos" \
  -H "Authorization: Bearer ACCESS_TOKEN"
```

## Query parameters

| Parameter | Type | Description |
| - | - | - |
| `channel_id` | string | Filter by kiosk channel. External channel identifier. When omitted, every non-deleted device for the merchant is returned. |

## Response

`data` is an array of devices, newest first. Each device includes the pairing code, the code printed on the tablet, store and channel ids, status, health, software, and the derived fields the dashboard uses: `app_presence`, `app_update_status`, `is_online`, and `can_operate`.

| Field | Description |
| - | - |
| `status` | `PENDING`, `LINKED`, `ENROLLED`, `DISABLED`, or `UNLINKED`. A device created through this API starts as `LINKED`. |
| `pairing_code` | Six-character code generated when the device is created. |
| `device_code` | Code the tablet shows. Stored uppercase. |
| `settings_overrides.disabled_payment_ids` | Payment configuration ids turned off on this device. |
| `health` | Battery, charging, storage, network, and app state reported by the tablet. |
| `software` | Android and app version reported by the tablet. |
| `app_presence` | `FOREGROUND`, `BACKGROUND`, `CLOSED`, or `UNKNOWN`. |
| `app_update_status` | `CURRENT`, `OUTDATED`, `UPDATING`, `FAILED`, or `UNKNOWN`. |
| `is_online` | Whether the tablet has checked in recently. |
| `can_operate` | Whether the device can take orders. |

```json Success theme={null}
{
  "data": [
    {
      "id": "counter-1",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "merchant_id": "a3f3ee84-ddc6-44aa-8f86-d2e9270dcdec",
      "channel_id": "kioscos",
      "channel_uid": "b1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "store_id": "downtown",
      "store_uid": "c1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "alias": "Counter 1",
      "pairing_code": "K7M2QX",
      "device_code": "TABLET01",
      "settings_overrides": { "disabled_payment_ids": [] },
      "status": "LINKED",
      "last_seen_at": "2026-09-25T16:00:00.000Z",
      "health": { "battery_pct": 82, "charging": true, "app_state": "active" },
      "software": { "app_version_name": "1.4.0", "app_version_code": 140 },
      "app_track_ids": [],
      "app_update_status": "CURRENT",
      "can_operate": true,
      "is_online": true,
      "app_presence": "FOREGROUND"
    }
  ]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.