PureBasic / Postman API / All workspaces
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"X-API-Key","{{postman_api_key}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.getpostman.com/workspaces",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
id.s
name.s
v_type.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"workspaces")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"workspaces[i].id")
name = CkJsonObject::ckStringOf(jResp,"workspaces[i].name")
v_type = CkJsonObject::ckStringOf(jResp,"workspaces[i].type")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}