Zoom Public API Documentation
List emergency addresses
GET {{baseUrl}}/phone/emergency_addresses?site_id=<string>&user_id=<string>&level=2&status=4&address_keyword=<string>&next_page_token=<string>&page_size=30
Lists the emergency addresses. Prerequisites:
* Pro or a higher account with Zoom Phone license
* Account owner or admin permissions Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:list_emergency_addresses:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
site_id
|
string | The emergency address site ID. | |
user_id
|
string | User ID to which the personal emergency address belongs. | |
level
|
number | The emergency address owner level: * `0` - Account/Company-level emergency address. * `1` - User/Personal-level emergency address. * `2` - Unknown company/pending emergency address. | |
status
|
number | The emergency address verification status: * `1` — Verification not Required. * `2` — Unverified. * `3` — Verification requested. * `4` — Verified. * `5` — Rejected. * `6` — Verification failed. | |
address_keyword
|
string | Keyword(s) to filter emergency addresses. You can filter by either: * Address Line 1. * Address Line 2. * City. * State Abbreviation. * Zip Code. | |
next_page_token
|
string | The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
page_size
|
number | The number of records returned within a single API call. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"emergency_addresses": [
{
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"country": "<string>",
"id": "<string>",
"is_default": "<boolean>",
"level": 1,
"owner": {
"extension_number": "<long>",
"id": "<string>",
"name": "<string>"
},
"site": {
"id": "<string>",
"name": "<string>"
},
"state_code": "<string>",
"status": 5,
"zip": "<string>"
},
{
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"country": "<string>",
"id": "<string>",
"is_default": "<boolean>",
"level": 1,
"owner": {
"extension_number": "<long>",
"id": "<string>",
"name": "<string>"
},
"site": {
"id": "<string>",
"name": "<string>"
},
"state_code": "<string>",
"status": 6,
"zip": "<string>"
}
],
"next_page_token": "<string>",
"page_size": "<integer>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/emergency_addresses?site_id=<string>&user_id=<string>&level=2&status=4&address_keyword=<string>&next_page_token=<string>&page_size=30?site_id=<string>&user_id=<string>&level=2&status=4&address_keyword=<string>&next_page_token=<string>&page_size=30' -H 'Accept: application/json'
ENDPOINTS