Chilkat Online Tools

TCL / Squadcast API V3 / Get All Users

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "Authorization" ""

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://api.squadcast.com/v3/users" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

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

# {
#   "data": [
#     {
#       "id": "5d81d9187000fb6b9def7e31",
#       "first_name": "Manigandan",
#       "last_name": "Dharmalingam",
#       "email": "manigandan@squadcast.com",
#       "contact": {
#         "dial_code": "+91",
#         "phone_number": "9578628779"
#       },
#       "secondary_emails": [
#       ],
#       "email_verified": true,
#       "time_zone": "Asia/Calcutta",
#       "title": "",
#       "bio": "",
#       "notification_rules": [
#         {
#           "type": "Email",
#           "time": 0
#         },
#         {
#           "type": "Push",
#           "time": 0
#         },
#         {
#           "type": "SMS",
#           "time": 1
#         },
#         {
#           "type": "Phone",
#           "time": 2
#         }
#       ],
#       "user_image": false,
#       "role_id": "5a425b383c36823b3ed91fb4",
#       "role": "account_owner"
#     },
#     {
#       "id": "5d91d262a2c85fa24a27d4d7",
#       "first_name": "Akilan",
#       "last_name": "Elango",
#       "email": "akilan@squadcast.com",
#       "contact": {
#         "dial_code": "",
#         "phone_number": ""
#       },
#       "secondary_emails": null,
#       "email_verified": false,
#       "time_zone": "",
#       "title": "",
#       "bio": "",
#       "notification_rules": [
#         {
#           "type": "Email",
#           "time": 0
#         },
#         {
#           "type": "Push",
#           "time": 0
#         },
#         {
#           "type": "SMS",
#           "time": 1
#         },
#         {
#           "type": "Phone",
#           "time": 2
#         }
#       ],
#       "user_image": false,
#       "role_id": "5a425b383c36823b3ed91fb5",
#       "role": "admin"
#     },
#     {
#       "id": "5d91d262a2c85fa24a27d4da",
#       "first_name": "Madhu",
#       "last_name": "DS Frontend",
#       "email": "madhu@squadcast.com",
#       "contact": {
#         "dial_code": "",
#         "phone_number": ""
#       },
#       "secondary_emails": null,
#       "email_verified": false,
#       "time_zone": "",
#       "title": "",
#       "bio": "",
#       "notification_rules": [
#         {
#           "type": "Email",
#           "time": 0
#         },
#         {
#           "type": "Push",
#           "time": 0
#         },
#         {
#           "type": "SMS",
#           "time": 1
#         },
#         {
#           "type": "Phone",
#           "time": 2
#         }
#       ],
#       "user_image": false,
#       "role_id": "5a425b383c36823b3ed91fb6",
#       "role": "user"
#     }
#   ]
# }

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

set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set id [CkJsonObject_stringOf $jResp "data[i].id"]
    set first_name [CkJsonObject_stringOf $jResp "data[i].first_name"]
    set last_name [CkJsonObject_stringOf $jResp "data[i].last_name"]
    set email [CkJsonObject_stringOf $jResp "data[i].email"]
    set Dial_code [CkJsonObject_stringOf $jResp "data[i].contact.dial_code"]
    set Phone_number [CkJsonObject_stringOf $jResp "data[i].contact.phone_number"]
    set email_verified [CkJsonObject_BoolOf $jResp "data[i].email_verified"]
    set time_zone [CkJsonObject_stringOf $jResp "data[i].time_zone"]
    set title [CkJsonObject_stringOf $jResp "data[i].title"]
    set bio [CkJsonObject_stringOf $jResp "data[i].bio"]
    set user_image [CkJsonObject_BoolOf $jResp "data[i].user_image"]
    set role_id [CkJsonObject_stringOf $jResp "data[i].role_id"]
    set role [CkJsonObject_stringOf $jResp "data[i].role"]
    set secondary_emails [CkJsonObject_stringOf $jResp "data[i].secondary_emails"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "data[i].secondary_emails"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "data[i].notification_rules"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set v_type [CkJsonObject_stringOf $jResp "data[i].notification_rules[j].type"]
        set time [CkJsonObject_IntOf $jResp "data[i].notification_rules[j].time"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-H "Authorization: "
https://api.squadcast.com/v3/users

Postman Collection Item JSON

{
  "name": "Get All Users",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": ""
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/users",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "users"
      ]
    },
    "description": "Returns all the users of the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope.\n        "
  },
  "response": [
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"data\": [\n  {\n   \"id\": \"5d81d9187000fb6b9def7e31\",\n   \"first_name\": \"Manigandan\",\n   \"last_name\": \"Dharmalingam\",\n   \"email\": \"manigandan@squadcast.com\",\n   \"contact\": {\n    \"dial_code\": \"+91\",\n    \"phone_number\": \"9578628779\"\n   },\n   \"secondary_emails\": [],\n   \"email_verified\": true,\n   \"time_zone\": \"Asia/Calcutta\",\n   \"title\": \"\",\n   \"bio\": \"\",\n   \"notification_rules\": [\n    {\n     \"type\": \"Email\",\n     \"time\": 0\n    },\n    {\n     \"type\": \"Push\",\n     \"time\": 0\n    },\n    {\n     \"type\": \"SMS\",\n     \"time\": 1\n    },\n    {\n     \"type\": \"Phone\",\n     \"time\": 2\n    }\n   ],\n   \"user_image\": false,\n   \"role_id\": \"5a425b383c36823b3ed91fb4\",\n   \"role\": \"account_owner\"\n  },\n  {\n   \"id\": \"5d91d262a2c85fa24a27d4d7\",\n   \"first_name\": \"Akilan\",\n   \"last_name\": \"Elango\",\n   \"email\": \"akilan@squadcast.com\",\n   \"contact\": {\n    \"dial_code\": \"\",\n    \"phone_number\": \"\"\n   },\n   \"secondary_emails\": null,\n   \"email_verified\": false,\n   \"time_zone\": \"\",\n   \"title\": \"\",\n   \"bio\": \"\",\n   \"notification_rules\": [\n    {\n     \"type\": \"Email\",\n     \"time\": 0\n    },\n    {\n     \"type\": \"Push\",\n     \"time\": 0\n    },\n    {\n     \"type\": \"SMS\",\n     \"time\": 1\n    },\n    {\n     \"type\": \"Phone\",\n     \"time\": 2\n    }\n   ],\n   \"user_image\": false,\n   \"role_id\": \"5a425b383c36823b3ed91fb5\",\n   \"role\": \"admin\"\n  },\n  {\n   \"id\": \"5d91d262a2c85fa24a27d4da\",\n   \"first_name\": \"Madhu\",\n   \"last_name\": \"DS Frontend\",\n   \"email\": \"madhu@squadcast.com\",\n   \"contact\": {\n    \"dial_code\": \"\",\n    \"phone_number\": \"\"\n   },\n   \"secondary_emails\": null,\n   \"email_verified\": false,\n   \"time_zone\": \"\",\n   \"title\": \"\",\n   \"bio\": \"\",\n   \"notification_rules\": [\n    {\n     \"type\": \"Email\",\n     \"time\": 0\n    },\n    {\n     \"type\": \"Push\",\n     \"time\": 0\n    },\n    {\n     \"type\": \"SMS\",\n     \"time\": 1\n    },\n    {\n     \"type\": \"Phone\",\n     \"time\": 2\n    }\n   ],\n   \"user_image\": false,\n   \"role_id\": \"5a425b383c36823b3ed91fb6\",\n   \"role\": \"user\"\n  }\n ]\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    }
  ]
}