List phones

GET

/v1/devices

const url = 'https://your-machine.your-tailnet.ts.net/v1/devices';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://your-machine.your-tailnet.ts.net/v1/devices \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer
apiKey

Responses

200

Paired phones with connection state and health.

application/json

object

devices

Array<object>

object

string

name

string

connected

boolean

registeredAt

string format: date-time

lastSeenAt

string format: date-time

latencyMs

Round trip to the phone

integer

health

Latest report from the phone (on connect, every 60 s and on network changes).

object

battery

integer

<= 100

charging

boolean

network

string

Allowed values: wifi cellular ethernet other none

signal

integer

<= 4

carrier

string

audio

State of the phone’s call-audio helper.

string

Allowed values: running stopped pairing_required

appVersion

string

android

string

model

string

reportedAt

string format: date-time

Example

{
  "devices": [
    {
      "id": "phone-7f3a91c2",
      "name": "Vivo V2348",
      "health": {
        "network": "wifi",
        "carrier": "Jio",
        "audio": "running"
      }
    }
  ]
}