Zoom Public API Documentation
List variables
GET {{baseUrl}}/contact_center/variables?variable_group_id=<string>&data_type=currency&variable_type=global_variable&next_page_token=<string>&page_size=30
Returns a list of variables for a specific variable group. Scopes: Rate Limit Label: contact_center_variable:read:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
variable_group_id
|
string | (Required) The variable's group ID. | |
data_type
|
string | The data's type. * `string` * `number` * `boolean` * `date_time` * `currency` * `percentage` * `email` * `url` * `phone` - ([E.164 format](https://en.wikipedia.org/wiki/E.164)) | |
variable_type
|
string | The variable's type. * `global_variable` * `address_book_variable` | |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size
|
number | The number of items returned per page. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"total_records": "<integer>",
"variables": [
{
"variable_id": "<string>",
"variable_group_id": "<string>",
"variable_name": "<string>",
"default_value": "<string>",
"variable_type": "address_book_variable",
"data_type": "percentage",
"variable_description": "<string>",
"mask_variable_data": false,
"values": [
"<string>",
"<string>"
],
"value_category": "<string>",
"used_in_address_book_count": "<integer>"
},
{
"variable_id": "<string>",
"variable_group_id": "<string>",
"variable_name": "<string>",
"default_value": "<string>",
"variable_type": "global_variable",
"data_type": "boolean",
"variable_description": "<string>",
"mask_variable_data": false,
"values": [
"<string>",
"<string>"
],
"value_category": "<string>",
"used_in_address_book_count": "<integer>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/variables?variable_group_id=<string>&data_type=currency&variable_type=global_variable&next_page_token=<string>&page_size=30?variable_group_id=<string>&data_type=currency&variable_type=global_variable&next_page_token=<string>&page_size=30' -H 'Accept: application/json'
ENDPOINTS