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:
phone:read:admin
Granular Scopes:
phone:read:list_emergency_addresses:admin
Rate Limit Label
:
Medium
Request Params
| 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":"\u003cstring\u003e","address_line2":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","id":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","level":1,"owner":{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"state_code":"\u003cstring\u003e","status":5,"zip":"\u003cstring\u003e"},{"address_line1":"\u003cstring\u003e","address_line2":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","id":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","level":1,"owner":{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"state_code":"\u003cstring\u003e","status":6,"zip":"\u003cstring\u003e"}],"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","total_records":"\u003cinteger\u003e"}