List tracked locations

GET {{baseUrl}}/phone/metrics/location_tracking?type=5&site_id=<string>&location_type=unknown&keyword=<string>

Lists the tracked locations.

Prerequisites: * Pro or higher account plan with Zoom phone license * Account owner or admin permissions

Scopes: phone:read:admin

Granular Scopes: phone:read:list_tracked_locations:admin

Rate Limit Label: Medium

Request Params

KeyDatatypeRequiredDescription
typenumberThe type of response data. Supports only six responses at this time.
1: Nomadic Emergency Services.
2: Users Permission for Location Sharing.
3: Default Emergency Address.
4: Detectable Personal Location.
5: Real-time Location for Users.
6: Real-time Location for IP Phones.
site_idstringThe site's ID.
location_typestringThe location's type. 'Company' is the default value.
keywordstringThe device name or device MAC address.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;location_tracking&quot;:[{&quot;assignees&quot;:[{&quot;extension_number&quot;:&quot;\u003clong\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;},{&quot;extension_number&quot;:&quot;\u003clong\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;}],&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;device&quot;:{&quot;bssid&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;mac_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;private_ip&quot;:&quot;\u003cstring\u003e&quot;,&quot;public_ip&quot;:&quot;\u003cstring\u003e&quot;},&quot;emergency_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;network_switch&quot;:{&quot;mac_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;port&quot;:&quot;\u003cstring\u003e&quot;},&quot;site&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;},&quot;type&quot;:&quot;company&quot;,&quot;zip&quot;:&quot;\u003cstring\u003e&quot;},{&quot;assignees&quot;:[{&quot;extension_number&quot;:&quot;\u003clong\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;},{&quot;extension_number&quot;:&quot;\u003clong\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;}],&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;device&quot;:{&quot;bssid&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;mac_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;private_ip&quot;:&quot;\u003cstring\u003e&quot;,&quot;public_ip&quot;:&quot;\u003cstring\u003e&quot;},&quot;emergency_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;network_switch&quot;:{&quot;mac_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;port&quot;:&quot;\u003cstring\u003e&quot;},&quot;site&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;},&quot;type&quot;:&quot;company&quot;,&quot;zip&quot;:&quot;\u003cstring\u003e&quot;}],&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;page_size&quot;:30,&quot;total_records&quot;:&quot;\u003cinteger\u003e&quot;}