Chilkat Online Tools

Swift / Squadcast API V3 / Get All Users

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    http.SetRequestHeader("Authorization", value: "")

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://api.squadcast.com/v3/users", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

    // 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

    var id: String?
    var first_name: String?
    var last_name: String?
    var email: String?
    var Dial_code: String?
    var Phone_number: String?
    var email_verified: Bool
    var time_zone: String?
    var title: String?
    var bio: String?
    var user_image: Bool
    var role_id: String?
    var role: String?
    var secondary_emails: String?
    var j: Int
    var count_j: Int
    var v_type: String?
    var time: Int

    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("data").intValue
    while i < count_i {
        jResp.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").intValue
        while j < count_j {
            jResp.J = j
            j = j + 1
        }

        j = 0
        count_j = jResp.SizeOfArray("data[i].notification_rules").intValue
        while j < count_j {
            jResp.J = j
            v_type = jResp.StringOf("data[i].notification_rules[j].type")
            time = jResp.IntOf("data[i].notification_rules[j].time").intValue
            j = j + 1
        }

        i = i + 1
    }


}

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