List activation codes
GET {{baseUrl}}/phone/common_areas/activation_codes?page_size=30&next_page_token=<string>
Returns a list of activation code information of the common areas under an account.
Note
: This API serves customers who opted for
Common Area Optimization
.
Prerequisites:
- Pro or a higher account with Zoom Phone license
- Account owner or admin permissions
Scopes:
phone:read:admin
Granular Scopes:
phone:read:list_common_area_activation_codes:admin
Rate Limit Label
:
MEDIUM
Not supported in Gov cluster
Request Params
| Key | Datatype | Required | Description |
| page_size | number | | The total number of records returned from a single API call. |
| next_page_token | string | | The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"common_areas_activation_codes":[{"common_area_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","extension_number":"\u003clong\u003e","activation_code":"\u003cstring\u003e","activation_code_expiration":"\u003cstring\u003e","status":"not_used","site":{"site_id":"\u003cstring\u003e","name":"\u003cstring\u003e"}},{"common_area_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","extension_number":"\u003clong\u003e","activation_code":"\u003cstring\u003e","activation_code_expiration":"\u003cstring\u003e","status":"not_used","site":{"site_id":"\u003cstring\u003e","name":"\u003cstring\u003e"}}],"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e"}