Skip to main content
GET
/
phones
List Phones
curl --request GET \
  --url https://api.example.com/phones
List all phones currently registered with your organization.

​
Request

curl https://api.tapkit.ai/phones \
  -H "X-API-Key: TK_your_api_key"

​
Response

[
  {
    "id": "abc123-def456",
    "name": "iPhone 15 Pro",
    "unique_id": "00008030-001A2B3C4D5E6F",
    "phone_number": null
  }
]

​
Response Fields

FieldTypeDescription
idstringServer-assigned phone identifier
namestringDevice display name
unique_idstringHardware identifier (UDID)
phone_numberstring | nullPhone number if available

​
Examples

​
List All Phones

import requests

response = requests.get(
    "https://api.tapkit.ai/phones",
    headers={"X-API-Key": "TK_..."}
)
phones = response.json()

for phone in phones:
    print(f"{phone['name']} ({phone['id']})")

​
Find Phone by Name

phones = response.json()
iphone_15 = next(
    (p for p in phones if "iPhone 15" in p["name"]),
    None
)

if iphone_15:
    phone_id = iphone_15["id"]

​
Notes

  • Returns an empty array [] if no phones are connected
  • Phone IDs remain stable for the same physical device
  • The unique_id corresponds to the device’s UDID