Chilkat Online Tools

Powershell / Zoom API / List past meeting instances

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-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/past_meetings/:meetingId/instances",$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)

# {
#   "meetings": [
#     {
#       "uuid": "tempor consequat",
#       "start_time": "1942-11-10T02:20:38.010Z"
#     },
#     {
#       "uuid": "ut",
#       "start_time": "2021-01-29T21:43:43.919Z"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$i = 0
$count_i = $jResp.SizeOfArray("meetings")
while ($i -lt $count_i) {
    $jResp.I = $i
    $uuid = $jResp.StringOf("meetings[i].uuid")
    $start_time = $jResp.StringOf("meetings[i].start_time")
    $i = $i + 1
}

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/past_meetings/:meetingId/instances

Postman Collection Item JSON

{
  "name": "List past meeting instances",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/past_meetings/:meetingId/instances",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "past_meetings",
        ":meetingId",
        "instances"
      ],
      "variable": [
        {
          "key": "meetingId",
          "value": "68423085",
          "description": "(Required) The past meeting's ID. The meeting ID must be from within the last 30 days. Past meeting IDs expire after 30 days."
        }
      ]
    },
    "description": "Use this API to return a list of past meeting instances. \n\n **Scopes:** `meeting:read:admin`, `meeting:read` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200` <br>\n List of ended meeting instances returned.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/past_meetings/:meetingId/instances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "past_meetings",
            ":meetingId",
            "instances"
          ],
          "variable": [
            {
              "key": "meetingId",
              "value": "68423085",
              "description": "(Required) The past meeting's ID. The meeting ID must be from within the last 30 days. Past meeting IDs expire after 30 days."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meetings\": [\n  {\n   \"uuid\": \"tempor consequat\",\n   \"start_time\": \"1942-11-10T02:20:38.010Z\"\n  },\n  {\n   \"uuid\": \"ut\",\n   \"start_time\": \"2021-01-29T21:43:43.919Z\"\n  }\n ]\n}"
    },
    {
      "name": "**HTTP Status Code:** `404` <br>\n Meeting not found.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/past_meetings/:meetingId/instances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "past_meetings",
            ":meetingId",
            "instances"
          ],
          "variable": [
            {
              "key": "meetingId",
              "value": "68423085",
              "description": "(Required) The past meeting's ID. The meeting ID must be from within the last 30 days. Past meeting IDs expire after 30 days."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}