Chilkat Online Tools

Powershell / Postman API / All workspaces

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

$http.SetRequestHeader("X-API-Key","{{postman_api_key}}")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://api.getpostman.com/workspaces",$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)

# {
#   "workspaces": [
#     {
#       "id": "4e6d34c2-cfdb-4b33-8868-12a875bebda3",
#       "name": "My Workspace",
#       "type": "personal"
#     },
#     {
#       "id": "f8801e9e-03a4-4c7b-b31e-5db5cd771696",
#       "name": "Team workspace",
#       "type": "team"
#     }
#   ]
# }

# 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("workspaces")
while ($i -lt $count_i) {
    $jResp.I = $i
    $id = $jResp.StringOf("workspaces[i].id")
    $name = $jResp.StringOf("workspaces[i].name")
    $v_type = $jResp.StringOf("workspaces[i].type")
    $i = $i + 1
}

Curl Command

curl -X GET
	-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/workspaces

Postman Collection Item JSON

{
  "name": "All workspaces",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/workspaces",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "workspaces"
      ]
    },
    "description": "The `/workspaces` endpoint returns a list of all [workspaces](https://www.getpostman.com/docs/v6/postman/workspaces/intro_to_workspaces) that is accessible by you. The list includes your own workspaces and the workspaces that you have access to.\n\nThe response contains an array of collection information containing the `name`, `id`, and `type` of each workspace.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "Valid Response",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/workspaces",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "workspaces"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "description": {
            "content": "",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"workspaces\": [\n        {\n            \"id\": \"4e6d34c2-cfdb-4b33-8868-12a875bebda3\",\n            \"name\": \"My Workspace\",\n            \"type\": \"personal\"\n        },\n        {\n            \"id\": \"f8801e9e-03a4-4c7b-b31e-5db5cd771696\",\n            \"name\": \"Team workspace\",\n            \"type\": \"team\"\n        }\n    ]\n}"
    }
  ]
}