Zoom Public API Documentation
List all whiteboards
GET {{baseUrl}}/whiteboards?search_key=<string>&user_id=<string>&date_filter_type=modified_date&from=<dateTime>&to=<dateTime>&page_size=10&next_page_token=<string>
Use this API to list whiteboards of current user (Required Scopes: Note: Scopes: Rate Limit Label: whiteboard:read) or list all whiteboards under the account (Required Scopes: whiteboard:read:admin).user_id can intake Zoom user ID or email which only applies when scope = whiteboard:read:admin. Otherwise, the user_id can only intake me.whiteboard:read:admin,whiteboard:readMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
search_key
|
string | The name of a whiteboard. If this parameter is provided, only the matched whiteboard will be returned. Otherwise, all whiteboards will be returned. | |
user_id
|
string | The email address or user ID of the whiteboard owner. If this parameter is provided, only the whiteboard owned by the provided user will be returned. If set to `me`, will return the matched whiteboards of current user. | |
date_filter_type
|
string | The whiteboard date filter type. Enum: * `created_date` - Whiteboard create date. * `modified_date` - Whiteboard modify date. | |
from
|
string | The queried start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` UTC format for the created date range for which you would like to retrieve whiteboards. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the “from” and “to” parameters, by default the value of 'from' field will be “2020-06-30” and the value of the 'to' field will be “2020-07-01”. | |
to
|
string | The queried end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` UTC format. | |
page_size
|
number | The number of records returned from a single API call. | |
next_page_token
|
string | The next page token is used to paginate through large result sets. A next page token will be returned 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
| {
"whiteboards": [
{
"whiteboard_id": "<string>",
"whiteboard_name": "Untitled",
"locked": false,
"trashed": false,
"readonly": false,
"non_cloud": false,
"created_date": "<dateTime>",
"modified_date": "<dateTime>",
"share_link_setting": {
"share_scope": 0,
"share_role": 3
},
"advanced_share_setting": {
"can_share": "<boolean>",
"share_to_external": "<boolean>",
"external_can_share": "<boolean>"
}
},
{
"whiteboard_id": "<string>",
"whiteboard_name": "Untitled",
"locked": false,
"trashed": false,
"readonly": false,
"non_cloud": false,
"created_date": "<dateTime>",
"modified_date": "<dateTime>",
"share_link_setting": {
"share_scope": 0,
"share_role": 4
},
"advanced_share_setting": {
"can_share": "<boolean>",
"share_to_external": "<boolean>",
"external_can_share": "<boolean>"
}
}
],
"next_page_token": "<string>",
"page_size": "<integer>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/whiteboards?search_key=<string>&user_id=<string>&date_filter_type=modified_date&from=<dateTime>&to=<dateTime>&page_size=10&next_page_token=<string>?search_key=<string>&user_id=<string>&date_filter_type=modified_date&from=<dateTime>&to=<dateTime>&page_size=10&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS