Chilkat Online Tools

Ruby / Squadcast API V3 / Get All Users

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.SetRequestHeader("Authorization","")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.squadcast.com/v3/users",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# 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

i = 0
count_i = jResp.SizeOfArray("data")
while i < count_i
    jResp.put_I(i)
    id = jResp.stringOf("data[i].id")
    first_name = jResp.stringOf("data[i].first_name")
    last_name = jResp.stringOf("data[i].last_name")
    email = jResp.stringOf("data[i].email")
    Dial_code = jResp.stringOf("data[i].contact.dial_code")
    Phone_number = jResp.stringOf("data[i].contact.phone_number")
    email_verified = jResp.BoolOf("data[i].email_verified")
    time_zone = jResp.stringOf("data[i].time_zone")
    title = jResp.stringOf("data[i].title")
    bio = jResp.stringOf("data[i].bio")
    user_image = jResp.BoolOf("data[i].user_image")
    role_id = jResp.stringOf("data[i].role_id")
    role = jResp.stringOf("data[i].role")
    secondary_emails = jResp.stringOf("data[i].secondary_emails")
    j = 0
    count_j = jResp.SizeOfArray("data[i].secondary_emails")
    while j < count_j
        jResp.put_J(j)
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("data[i].notification_rules")
    while j < count_j
        jResp.put_J(j)
        v_type = jResp.stringOf("data[i].notification_rules[j].type")
        time = jResp.IntOf("data[i].notification_rules[j].time")
        j = j + 1
    end
    i = i + 1
end

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}"
    }
  ]
}