List Paired Devices

Lists the iPhones and iPads paired to the account, active devices first. Use it to check that a device is paired before you send, or to find device IDs for Channels. An empty list means no device is paired yet: install the ActivitySmith app from the App Store and sign in. Channel-scoped API keys cannot list devices.

GET https://activitysmith.com/api/account/devices

Authentication#

Use your API key in the request header.

Authorization: Bearer $YOUR_API_KEY

Parameters#

limit#

query parameter. Optional.

Maximum devices to return, 1 to 100. Defaults to 100.

Type: integer

Minimum: 1; Maximum: 100; Default: 100

offset#

query parameter. Optional.

Devices to skip. Use meta.next_offset from the previous page.

Type: integer

Minimum: 0; Default: 0

include_inactive#

query parameter. Optional.

Include devices that can no longer receive deliveries, such as unpaired phones.

Type: boolean

Default: false

Request examples#

import ActivitySmith from "activitysmith";
const activitysmith = new ActivitySmith({
  apiKey: process.env.ACTIVITYSMITH_API_KEY,
});
const { devices } = await activitysmith.devices.list();
for (const device of devices) {
  console.log(device.device_name, device.system_name, device.is_active);
}

Responses#

200#

Paired devices

Content type: application/json

Schema: AccountDeviceListResponse#

devicesarray of AccountDevicerequired

metaobjectrequired

meta.totalintegerrequired

Devices matching the filter.

meta.limitintegerrequired

meta.offsetintegerrequired

meta.has_morebooleanrequired

meta.next_offsetinteger or nullrequired

Offset for the next page, or null on the last page.

meta.include_inactivebooleanrequired

default

{
  "devices": [
    {
      "user_email": "you@example.com",
      "device_id": "4F1C2A8E-7B3D-4E21-9A6C-1D2E3F4A5B6C",
      "device_type": "ios",
      "is_active": true,
      "token_status": {
        "push": true,
        "start_live_activity": true
      },
      "app_version": "1.17.0",
      "device_name": "iPhone",
      "system_name": "iOS",
      "system_version": "27.0",
      "created_at": "2026-10-01T09:00:00.000Z",
      "updated_at": "2026-10-26T12:00:00.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 100,
    "offset": 0,
    "has_more": false,
    "next_offset": null,
    "include_inactive": false
  }
}

no devices

{
  "devices": [],
  "meta": {
    "total": 0,
    "limit": 100,
    "offset": 0,
    "has_more": false,
    "next_offset": null,
    "include_inactive": false
  }
}

403#

The API key is limited to Channels

Content type: application/json

Schema: ForbiddenError#

errorstringrequired

messagestringrequired

Additional Properties: true

429#

Rate limit exceeded

Content type: application/json

Schema: RateLimitError#

codestring

Enum: ["rate_limited"]

errorstringrequired

messagestringrequired

Additional Properties: false

Download the OpenAPI specification