curl https://api.tapkit.ai/v1/phones \
-H "X-API-Key: $TAPKIT_API_KEY"
[
{
"id": "d9fb00a7-1c7a-44dc-88f6-d06ba5061fdd",
"name": "iPhone",
"display_name": "Test phone",
"connection_status": "online",
"activation_state": "active",
"connected_mac_id": "3f1e8c52-6a0b-4d8e-9b7a-1c2d3e4f5a6b",
"width": 1170,
"height": 2532,
"created_at": "2026-09-11T17:02:44Z"
}
]
Phones
List phones
List every phone in your organization
GET
/
phones
curl https://api.tapkit.ai/v1/phones \
-H "X-API-Key: $TAPKIT_API_KEY"
[
{
"id": "d9fb00a7-1c7a-44dc-88f6-d06ba5061fdd",
"name": "iPhone",
"display_name": "Test phone",
"connection_status": "online",
"activation_state": "active",
"connected_mac_id": "3f1e8c52-6a0b-4d8e-9b7a-1c2d3e4f5a6b",
"width": 1170,
"height": 2532,
"created_at": "2026-09-11T17:02:44Z"
}
]
Returns every phone your organization has connected, including offline ones.
The response has other fields that aren’t part of the API. Don’t rely on them.
Response
string
The phone’s ID. Pass it as
phone_id to every other endpoint.string
The name the phone reports, such as “Tom’s iPhone”.
string | null
The name you gave the phone in TapKit, if any. See Rename phone.
string
online if the phone is connected and selected on its Mac, available if it’s connected to a Mac but not selected, or offline.string
active or inactive. Only active phones accept actions.string | null
The Mac the phone is connected to.
integer | null
Screen width in pixels.
integer | null
Screen height in pixels.
string
When the phone was first connected.
curl https://api.tapkit.ai/v1/phones \
-H "X-API-Key: $TAPKIT_API_KEY"
[
{
"id": "d9fb00a7-1c7a-44dc-88f6-d06ba5061fdd",
"name": "iPhone",
"display_name": "Test phone",
"connection_status": "online",
"activation_state": "active",
"connected_mac_id": "3f1e8c52-6a0b-4d8e-9b7a-1c2d3e4f5a6b",
"width": 1170,
"height": 2532,
"created_at": "2026-09-11T17:02:44Z"
}
]