Logo
Zoom Public API Documentation

Get a variable

GET {{baseUrl}}/contact_center/variables/:variableId

Retrieve a variable.

Scopes: contact_center_variable:read:admin

Rate Limit Label: LIGHT

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "variable_id": "<string>", "variable_group_id": "<string>", "variable_name": "<string>", "variable_description": "<string>", "variable_type": "global_variable", "address_books": [ { "address_book_id": "<string>", "address_book_name": "<string>", "unit_id": "<string>", "unit_name": "<string>", "total_contacts": "<integer>" }, { "address_book_id": "<string>", "address_book_name": "<string>", "unit_id": "<string>", "unit_name": "<string>", "total_contacts": "<integer>" } ], "use_in_reporting": false, "mask_variable_data": false, "use_as_routing_profile_parameters": false, "data_type": "number", "value_category": "<string>", "values": [ "<string>", "<string>" ], "linked_value_lock": false, "default_value": "<string>", "use_in_external_url_parameters": "<boolean>", "client_show_in_client_profile_section": "<boolean>", "client_show_in_client_engagement_section": "<boolean>", "client_show_in_inbound_call_notifications": "<boolean>" }



Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/variables/:variableId' -H 'Accept: application/json'

ENDPOINTS