Powershell / Zoom API / Get a tracking field
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://api.zoom.us/v2/tracking_fields/:fieldId",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "id": "fdfgdfgr23gr1",
# "field": "Meeting Purpose",
# "required": true,
# "visible": false,
# "recommended_values": [
# "Support",
# "Onboarding",
# "Sales",
# "Other"
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$id = $jResp.StringOf("id")
$field = $jResp.StringOf("field")
$required = $jResp.BoolOf("required")
$visible = $jResp.BoolOf("visible")
$i = 0
$count_i = $jResp.SizeOfArray("recommended_values")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("recommended_values[i]")
$i = $i + 1
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/tracking_fields/:fieldId
Postman Collection Item JSON
{
"name": "Get a tracking field",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/tracking_fields/:fieldId",
"host": [
"{{baseUrl}}"
],
"path": [
"tracking_fields",
":fieldId"
],
"variable": [
{
"key": "fieldId",
"value": "quis officia in reprehenderit",
"description": "(Required) The Tracking Field ID"
}
]
},
"description": "Use this API to return information about a [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields). \n\n**Scopes:** `tracking_fields:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n**Prerequisites:** \n* A Business, Education, API or higher plan."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nTracking Field object returned",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/tracking_fields/:fieldId",
"host": [
"{{baseUrl}}"
],
"path": [
"tracking_fields",
":fieldId"
],
"variable": [
{
"key": "fieldId",
"value": "quis officia in reprehenderit",
"description": "(Required) The Tracking Field ID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"fdfgdfgr23gr1\",\n \"field\": \"Meeting Purpose\",\n \"required\": true,\n \"visible\": false,\n \"recommended_values\": [\n \"Support\",\n \"Onboarding\",\n \"Sales\",\n \"Other\"\n ]\n}"
},
{
"name": "**HTTP Status Code:** `404`<br>\nTracking Field not found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/tracking_fields/:fieldId",
"host": [
"{{baseUrl}}"
],
"path": [
"tracking_fields",
":fieldId"
],
"variable": [
{
"key": "fieldId",
"value": "quis officia in reprehenderit",
"description": "(Required) The Tracking Field ID"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}