Chilkat Online Tools

lianja / Postman API / All Collections

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

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

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.getpostman.com/collections",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "collections": [
//     {
//       "id": "dac5eac9-148d-a32e-b76b-3edee9da28f7",
//       "name": "Cloud API",
//       "owner": "631643",
//       "uid": "631643-dac5eac9-148d-a32e-b76b-3edee9da28f7"
//     },
//     {
//       "id": "f2e66c2e-5297-e4a5-739e-20cbb90900e3",
//       "name": "Sample Collection",
//       "owner": "631643",
//       "uid": "631643-f2e66c2e-5297-e4a5-739e-20cbb90900e3"
//     },
//     {
//       "id": "f695cab7-6878-eb55-7943-ad88e1ccfd65",
//       "name": "Postman Echo",
//       "owner": "631643",
//       "uid": "631643-f695cab7-6878-eb55-7943-ad88e1ccfd65"
//     }
//   ]
// }

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

i = 0
lnCount_i = loJResp.SizeOfArray("collections")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("collections[i].id")
    lcName = loJResp.StringOf("collections[i].name")
    lcOwner = loJResp.StringOf("collections[i].owner")
    lcUid = loJResp.StringOf("collections[i].uid")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "All Collections",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "pm.test(\"response is ok\", function () {",
          "    pm.response.to.have.status(200);",
          "});",
          "",
          "pm.test(\"response json data should not have errors\", function () {",
          "    pm.response.to.have.jsonBody();",
          "    pm.response.to.not.have.jsonBody('error');",
          "});",
          "",
          "pm.test(\"response json should contain collections\", function () {",
          "    pm.expect(pm.response.json()).to.have.property('collections').and.be.an('array');",
          "});",
          "",
          "// additional tests to ensure that the relevant environment variables are present",
          "pm.test('\"postman_api_key\" variable should be present', function () {",
          "    pm.expect(pm.variables.get('postman_api_key')).to.be.a('string');",
          "});"
        ]
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/collections",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "collections"
      ]
    },
    "description": "The `/collections` endpoint returns a list of all [collections](https://www.getpostman.com/docs/collections) that are accessible by you. The list includes your own collections and the collections that you have subscribed to.\n\nThe response contains an array of collection information containing the `name`, `id`, `owner` and `uid` of each collection.\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/collections",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "collections"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "description": {
            "content": "",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"collections\": [\n        {\n            \"id\": \"dac5eac9-148d-a32e-b76b-3edee9da28f7\",\n            \"name\": \"Cloud API\",\n            \"owner\": \"631643\",\n            \"uid\": \"631643-dac5eac9-148d-a32e-b76b-3edee9da28f7\"\n        },\n        {\n            \"id\": \"f2e66c2e-5297-e4a5-739e-20cbb90900e3\",\n            \"name\": \"Sample Collection\",\n            \"owner\": \"631643\",\n            \"uid\": \"631643-f2e66c2e-5297-e4a5-739e-20cbb90900e3\"\n        },\n        {\n            \"id\": \"f695cab7-6878-eb55-7943-ad88e1ccfd65\",\n            \"name\": \"Postman Echo\",\n            \"owner\": \"631643\",\n            \"uid\": \"631643-f695cab7-6878-eb55-7943-ad88e1ccfd65\"\n        }\n    ]\n}"
    }
  ]
}