Logo
Zoom Public API Documentation

Get operation logs report

GET {{baseUrl}}/phone/reports/operationlogs?from=<date>&to=<date>&category_type=all&page_size=30&next_page_token=<string>

Retrieves the phone system operation logs report.

The phone system operation logs report allows account owners and admins to view monthly Zoom phone related admin operation details.

Account owners and admins can also access this information by logging into their Zoom accounts and navigating to Phone System Operation Logs.

Prerequisites:

  • Account must be enrollled in Pro or a higher plan
  • Account must be enrolled in a Zoom Phone plan

Scopes: phone:read:admin

Granular Scopes: phone:read:operation_logs:admin

Rate Limit Label: HEAVY

 

Body PARAM

Key Datatype Required Description 
from
string The start time and date in **yyyy-mm-dd**format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data within the 24 hours.
to
string **Required** only when the `from` parameter is specified. The end time and date is in **yyyy-mm-dd** format; the same format as the `from` parameter.
category_type
string This field filters the response by the category of the action performed. By default, the value of this field is &quot;all&quot; and thus, the response will include log of all operations for the defined period. To only include response for a specific category type, provide a value for `category_type` from this [table](https://marketplace.zoom.us/docs/api-reference/other-references/phone-operation-categories).
page_size
number The number of records returned within a single API call.
next_page_token
string The next page token paginates through 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

{ "next_page_token": "<string>", "page_size": 30, "total_records": "<integer>", "from": "<string>", "to": "<string>", "operation_logs": [ { "action": "<string>", "category_type": "<string>", "operation_detail": "<string>", "operator": "<string>", "time": "<dateTime>" }, { "action": "<string>", "category_type": "<string>", "operation_detail": "<string>", "operator": "<string>", "time": "<dateTime>" } ] }



Curl
curl -X GET 'https://api.zoom.us/v2/phone/reports/operationlogs?from=<date>&to=<date>&category_type=all&page_size=30&next_page_token=<string>?from=<date>&to=<date>&category_type=all&page_size=30&next_page_token=<string>' -H 'Accept: application/json'

ENDPOINTS